<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.5">
<meta name="description" content="This guide describes the Asciidoctor attributes, values, and layout options available for producing a customized and polished document.">
<meta name="keywords" content="AsciiDoc, Asciidoctor, syntax, reference, learn, how to, AsciiMath, LaTeX math, MathJax, Pygments, CodeRay">
<meta name="author" content="Sarah White, Dan Allen">
<title>Asciidoctor User Manual</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Remove comment around @import statement below when using as a custom stylesheet */
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
audio,canvas,video{display:inline-block}
audio:not([controls]){display:none;height:0}
[hidden],template{display:none}
script{display:none!important}
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
a{background:transparent}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
abbr[title]{border-bottom:1px dotted}
b,strong{font-weight:bold}
dfn{font-style:italic}
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.center{margin-left:auto;margin-right:auto}
.spread{width:100%}
p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:none}
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.no-bullet{list-style:none}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
abbr{text-transform:none}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
blockquote cite:before{content:"\2014 \0020"}
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
table thead,table tfoot{background:#f7f8f7;font-weight:bold}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
.clearfix:after,.float-group:after{clear:both}
*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
*:not(pre)>code.nobreak{word-wrap:normal}
*:not(pre)>code.nowrap{white-space:nowrap}
pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menu{color:rgba(0,0,0,.8)}
b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
b.button:before{content:"[";padding:0 3px 0 2px}
b.button:after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
#header:after,#content:after,#footnotes:after,#footer:after{clear:both}
#content{margin-top:1.25em}
#content:before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span:before{content:"\00a0\2013\00a0"}
#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark:before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber:after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media only screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
.sect1{padding-bottom:.625em}
@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
.sect1+.sect1{border-top:1px solid #efefed}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.listingblock>.content{position:relative}
.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
.listingblock:hover code[data-lang]:before{display:block}
.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
table.pyhltable td.code{padding-left:.75em;padding-right:0}
pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
pre.pygments .lineno{display:inline-block;margin-right:.25em}
table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
.quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
.quoteblock .quoteblock blockquote:before{display:none}
.verseblock{margin:0 1em 1.25em 1em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract{margin:0 0 1.25em 0;display:block}
.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
table.tableblock{max-width:100%;border-collapse:separate}
table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
table.frame-all{border-width:1px}
table.frame-sides{border-width:0 1px}
table.frame-topbot{border-width:1px 0}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
td>div.verse{white-space:pre}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
ul.inline>li>*{display:block}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
.colist>table tr>td:last-of-type{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
.gist .file-data>table td.line-data{width:99%}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background-color:#00fafa}
.black{color:#000}
.black-background{background-color:#000}
.blue{color:#0000bf}
.blue-background{background-color:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background-color:#fa00fa}
.gray{color:#606060}
.gray-background{background-color:#7d7d7d}
.green{color:#006000}
.green-background{background-color:#007d00}
.lime{color:#00bf00}
.lime-background{background-color:#00fa00}
.maroon{color:#600000}
.maroon-background{background-color:#7d0000}
.navy{color:#000060}
.navy-background{background-color:#00007d}
.olive{color:#606000}
.olive-background{background-color:#7d7d00}
.purple{color:#600060}
.purple-background{background-color:#7d007d}
.red{color:#bf0000}
.red-background{background-color:#fa0000}
.silver{color:#909090}
.silver-background{background-color:#bcbcbc}
.teal{color:#006060}
.teal-background{background-color:#007d7d}
.white{color:#bfbfbf}
.white-background{background-color:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background-color:#fafa00}
span.icon>.fa{cursor:default}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]:after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@media print{@page{margin:1.25cm .75cm}
*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]:after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
.sect1{padding-bottom:0!important}
.sect1+.sect1{border:0!important}
#header>h1:first-child{margin-top:1.25rem}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span:before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]:before{display:block}
#footer{background:none!important;padding:0 .9375em}
#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
</style>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css">
<style>
/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
/*pre.CodeRay {background-color:#f7f7f8;}*/
.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
.CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
table.CodeRay td{vertical-align: top;line-height:1.45}
table.CodeRay td.line-numbers{text-align:right}
table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
table.CodeRay td.code{padding:0 0 0 .5em}
table.CodeRay td.code>pre{padding:0}
.CodeRay .debug{color:#fff !important;background:#000080 !important}
.CodeRay .annotation{color:#007}
.CodeRay .attribute-name{color:#000080}
.CodeRay .attribute-value{color:#700}
.CodeRay .binary{color:#509}
.CodeRay .comment{color:#998;font-style:italic}
.CodeRay .char{color:#04d}
.CodeRay .char .content{color:#04d}
.CodeRay .char .delimiter{color:#039}
.CodeRay .class{color:#458;font-weight:bold}
.CodeRay .complex{color:#a08}
.CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
.CodeRay .color{color:#099}
.CodeRay .class-variable{color:#369}
.CodeRay .decorator{color:#b0b}
.CodeRay .definition{color:#099}
.CodeRay .delimiter{color:#000}
.CodeRay .doc{color:#970}
.CodeRay .doctype{color:#34b}
.CodeRay .doc-string{color:#d42}
.CodeRay .escape{color:#666}
.CodeRay .entity{color:#800}
.CodeRay .error{color:#808}
.CodeRay .exception{color:inherit}
.CodeRay .filename{color:#099}
.CodeRay .function{color:#900;font-weight:bold}
.CodeRay .global-variable{color:#008080}
.CodeRay .hex{color:#058}
.CodeRay .integer,.CodeRay .float{color:#099}
.CodeRay .include{color:#555}
.CodeRay .inline{color:#000}
.CodeRay .inline .inline{background:#ccc}
.CodeRay .inline .inline .inline{background:#bbb}
.CodeRay .inline .inline-delimiter{color:#d14}
.CodeRay .inline-delimiter{color:#d14}
.CodeRay .important{color:#555;font-weight:bold}
.CodeRay .interpreted{color:#b2b}
.CodeRay .instance-variable{color:#008080}
.CodeRay .label{color:#970}
.CodeRay .local-variable{color:#963}
.CodeRay .octal{color:#40e}
.CodeRay .predefined{color:#369}
.CodeRay .preprocessor{color:#579}
.CodeRay .pseudo-class{color:#555}
.CodeRay .directive{font-weight:bold}
.CodeRay .type{font-weight:bold}
.CodeRay .predefined-type{color:inherit}
.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
.CodeRay .key{color:#808}
.CodeRay .key .delimiter{color:#606}
.CodeRay .key .char{color:#80f}
.CodeRay .value{color:#088}
.CodeRay .regexp .delimiter{color:#808}
.CodeRay .regexp .content{color:#808}
.CodeRay .regexp .modifier{color:#808}
.CodeRay .regexp .char{color:#d14}
.CodeRay .regexp .function{color:#404;font-weight:bold}
.CodeRay .string{color:#d20}
.CodeRay .string .string .string{background:#ffd0d0}
.CodeRay .string .content{color:#d14}
.CodeRay .string .char{color:#d14}
.CodeRay .string .delimiter{color:#d14}
.CodeRay .shell{color:#d14}
.CodeRay .shell .delimiter{color:#d14}
.CodeRay .symbol{color:#990073}
.CodeRay .symbol .content{color:#a60}
.CodeRay .symbol .delimiter{color:#630}
.CodeRay .tag{color:#008080}
.CodeRay .tag-special{color:#d70}
.CodeRay .variable{color:#036}
.CodeRay .insert{background:#afa}
.CodeRay .delete{background:#faa}
.CodeRay .change{color:#aaf;background:#007}
.CodeRay .head{color:#f8f;background:#505}
.CodeRay .insert .insert{color:#080}
.CodeRay .delete .delete{color:#800}
.CodeRay .change .change{color:#66f}
.CodeRay .head .head{color:#f4f}
</style>
</head>
<body class="book toc2 toc-left">
<div id="header">
<h1>Asciidoctor User Manual</h1>
<div class="details">
<span id="author" class="author">Sarah White</span><br>
<span id="email" class="email"><a href="https://twitter.com/carbonfray">@carbonfray</a></span><br>
<span id="author2" class="author">Dan Allen</span><br>
<span id="email2" class="email"><a href="https://github.com/mojavelinux">@mojavelinux</a></span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel0">
<li><a href="#introduction-to-asciidoctor">Introduction to Asciidoctor</a>
<ul class="sectlevel2">
<li><a href="#asciidoctor-s-most-notable-benefits">1.1. Asciidoctor&#8217;s Most Notable Benefits</a></li>
<li><a href="#compared-to-markdown">1.2. Compared to MarkDown</a></li>
</ul>
</li>
<li><a href="#quick-starts">Quick Starts</a>
<ul class="sectlevel1">
<li><a href="#installation-quick-start">1. Installation Quick Start</a></li>
<li><a href="#usage-quick-start">2. Usage Quick Start</a>
<ul class="sectlevel2">
<li><a href="#using-the-command-line-interface">2.1. Using the Command Line Interface</a></li>
<li><a href="#using-the-ruby-api">2.2. Using the Ruby API</a></li>
</ul>
</li>
<li><a href="#syntax-quick-start">3. Syntax Quick Start</a></li>
<li><a href="#custom-output-quick-start">4. Custom Output Quick Start</a></li>
</ul>
</li>
<li><a href="#getting-started">Getting Started</a>
<ul class="sectlevel1">
<li><a href="#system-requirements">5. System Requirements</a></li>
<li><a href="#installing-the-asciidoctor-ruby-gem">6. Installing the Asciidoctor Ruby Gem</a>
<ul class="sectlevel2">
<li><a href="#install-using-code-gem-code">6.1. Install using <code>gem</code></a></li>
<li><a href="#install-using-bundler">6.2. Install using Bundler</a></li>
<li><a href="#install-using-code-yum-code-or-code-dnf-code-on-fedora">6.3. Install using <code>yum</code> or <code>dnf</code> on Fedora</a></li>
<li><a href="#install-using-code-apt-get-code-on-debian-or-ubuntu">6.4. Install using <code>apt-get</code> on Debian or Ubuntu</a></li>
<li><a href="#install-using-code-apk-code-on-alpine-linux">6.5. Install using <code>apk</code> on Alpine Linux</a></li>
</ul>
</li>
<li><a href="#upgrading-the-asciidoctor-ruby-gem">7. Upgrading the Asciidoctor Ruby Gem</a></li>
<li><a href="#extensions-and-integrations">8. Extensions and Integrations</a></li>
</ul>
</li>
<li><a href="#terms-and-concepts">Terms and Concepts</a>
<ul class="sectlevel1">
<li><a href="#elements">9. Elements</a></li>
<li><a href="#macros">10. Macros</a></li>
<li><a href="#formatting-marks">11. Formatting Marks</a></li>
<li><a href="#attributes">12. Attributes</a>
<ul class="sectlevel2">
<li><a href="#attribute-assignment-precedence">12.1. Attribute Assignment Precedence</a></li>
<li><a href="#using-attributes-set-assign-and-reference">12.2. Using Attributes: Set, Assign, and Reference</a></li>
<li><a href="#setting-attributes-on-a-document">12.3. Setting Attributes on a Document</a></li>
<li><a href="#setting-attributes-on-an-element">12.4. Setting Attributes on an Element</a></li>
<li><a href="#assigning-document-attributes-inline">12.5. Assigning Document Attributes Inline</a></li>
<li><a href="#attribute-conventions">12.6. Attribute Conventions</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#building-a-document">Building a Document</a>
<ul class="sectlevel1">
<li><a href="#text-editor">13. Text Editor</a></li>
<li><a href="#document-types">14. Document Types</a></li>
<li><a href="#basic-document-anatomy">15. Basic Document Anatomy</a></li>
<li><a href="#doc-header">16. Header</a>
<ul class="sectlevel2">
<li><a href="#document-title">16.1. Document Title</a></li>
<li><a href="#author-and-email">16.2. Author and Email</a></li>
<li><a href="#revision-number-date-and-remark">16.3. Revision Number, Date and Remark</a></li>
<li><a href="#subtitle-partitioning">16.4. Subtitle Partitioning</a></li>
<li><a href="#metadata">16.5. Metadata</a></li>
<li><a href="#header-summary">16.6. Header Summary</a></li>
</ul>
</li>
<li><a href="#doc-preamble">17. Preamble</a></li>
<li><a href="#sections">18. Sections</a>
<ul class="sectlevel2">
<li><a href="#titles-as-html-headings">18.1. Titles as HTML Headings</a></li>
<li><a href="#auto-generated-ids">18.2. Auto-generated IDs</a></li>
<li><a href="#custom-ids">18.3. Custom IDs</a></li>
<li><a href="#links">18.4. Links</a></li>
<li><a href="#anchors">18.5. Anchors</a></li>
<li><a href="#numbering">18.6. Numbering</a></li>
<li><a href="#discrete-headings">18.7. Discrete Headings (aka Floating Titles)</a></li>
<li><a href="#section-styles">18.8. Section Styles</a></li>
<li><a href="#sections-summary">18.9. Sections Summary</a></li>
</ul>
</li>
<li><a href="#blocks">19. Blocks</a></li>
<li><a href="#paragraph">20. Paragraph</a>
<ul class="sectlevel2">
<li><a href="#line-breaks">20.1. Line Breaks</a></li>
<li><a href="#lead-style">20.2. Lead Style</a></li>
</ul>
</li>
<li><a href="#text-formatting">21. Text Formatting</a>
<ul class="sectlevel2">
<li><a href="#bold-and-italic">21.1. Bold and Italic</a></li>
<li><a href="#curved">21.2. Quotation Marks and Apostrophes</a></li>
<li><a href="#subscript-and-superscript">21.3. Subscript and Superscript</a></li>
<li><a href="#mono">21.4. Monospace</a></li>
<li><a href="#custom-styling-with-attributes">21.5. Custom Styling With Attributes</a></li>
</ul>
</li>
<li><a href="#unordered-lists">22. Unordered Lists</a>
<ul class="sectlevel2">
<li><a href="#nested">22.1. Nested</a></li>
<li><a href="#complex-list-content">22.2. Complex List Content</a></li>
<li><a href="#custom-markers">22.3. Custom Markers</a></li>
<li><a href="#checklist">22.4. Checklist</a></li>
<li><a href="#summary">22.5. Summary</a></li>
</ul>
</li>
<li><a href="#ordered-lists">23. Ordered Lists</a>
<ul class="sectlevel2">
<li><a href="#nested-2">23.1. Nested</a></li>
<li><a href="#numbering-styles">23.2. Numbering Styles</a></li>
<li><a href="#summary-2">23.3. Summary</a></li>
</ul>
</li>
<li><a href="#labeled-list">24. Labeled List</a>
<ul class="sectlevel2">
<li><a href="#question-and-answer-style-list">24.1. Question and Answer Style List</a></li>
<li><a href="#summary-3">24.2. Summary</a></li>
</ul>
</li>
<li><a href="#tables">25. Tables</a>
<ul class="sectlevel2">
<li><a href="#summary-tables">25.1. Summary</a></li>
</ul>
</li>
<li><a href="#horizontal-rules">26. Horizontal Rules</a></li>
<li><a href="#page-break">27. Page Break</a></li>
<li><a href="#url">28. URLs</a>
<ul class="sectlevel2">
<li><a href="#link-to-relative-files">28.1. Link to Relative Files</a></li>
<li><a href="#summary-4">28.2. Summary</a></li>
</ul>
</li>
<li><a href="#xref">29. Cross References</a>
<ul class="sectlevel2">
<li><a href="#automatic-anchors">29.1. Automatic Anchors</a></li>
<li><a href="#anchordef">29.2. Defining an Anchor</a></li>
<li><a href="#internal-cross-references">29.3. Internal Cross References</a></li>
<li><a href="#customizing-the-cross-reference-text">29.4. Customizing the Cross Reference Text</a></li>
<li><a href="#inter-document-cross-references">29.5. Inter-document Cross References</a></li>
</ul>
</li>
<li><a href="#include-directive">30. Include Directive</a>
<ul class="sectlevel2">
<li><a href="#include-partial">30.1. Select Portions of a Document to Include</a></li>
<li><a href="#normalize-block-indentation">30.2. Normalize Block Indentation</a></li>
<li><a href="#include-uri">30.3. Include Content from a URI</a></li>
<li><a href="#include-multiple">30.4. Include a File Multiple Times in the Same Document</a></li>
</ul>
</li>
<li><a href="#images">31. Images</a>
<ul class="sectlevel2">
<li><a href="#setting-the-location-of-images">31.1. Setting the Location of Images</a></li>
<li><a href="#putting-images-in-their-place">31.2. Putting Images in Their Place</a></li>
<li><a href="#sizing-images">31.3. Sizing Images</a></li>
<li><a href="#summary-5">31.4. Summary</a></li>
</ul>
</li>
<li><a href="#video">32. Video</a>
<ul class="sectlevel2">
<li><a href="#supported-attributes">32.1. Supported Attributes</a></li>
</ul>
</li>
<li><a href="#audio">33. Audio</a>
<ul class="sectlevel2">
<li><a href="#summary-6">33.1. Summary</a></li>
</ul>
</li>
<li><a href="#admonition">34. Admonition</a></li>
<li><a href="#sidebar">35. Sidebar</a></li>
<li><a href="#example">36. Example</a></li>
<li><a href="#prose-excerpts-quotes-and-verses">37. Prose Excerpts, Quotes and Verses</a>
<ul class="sectlevel2">
<li><a href="#quote">37.1. Quote</a></li>
<li><a href="#verse">37.2. Verse</a></li>
</ul>
</li>
<li><a href="#comments">38. Comments</a></li>
</ul>
</li>
<li><a href="#controlling-your-content">Controlling Your Content</a>
<ul class="sectlevel1">
<li><a href="#subs">39. Text Substitutions</a>
<ul class="sectlevel2">
<li><a href="#special-characters">39.1. Special Characters</a></li>
<li><a href="#quotes">39.2. Quotes</a></li>
<li><a href="#attributes-2">39.3. Attributes</a></li>
<li><a href="#replacements">39.4. Replacements</a></li>
<li><a href="#subs-mac">39.5. Macros</a></li>
<li><a href="#post-replacements">39.6. Post Replacements</a></li>
<li><a href="#applying-substitutions">39.7. Applying Substitutions</a></li>
<li><a href="#preventing-substitutions">39.8. Preventing Substitutions</a></li>
</ul>
</li>
<li><a href="#literal-text-and-blocks">40. Literal Text and Blocks</a></li>
<li><a href="#listing-blocks">41. Listing Blocks</a>
<ul class="sectlevel2">
<li><a href="#to-wrap-or-to-scroll">41.1. To Wrap or to Scroll</a></li>
<li><a href="#summary-7">41.2. Summary</a></li>
</ul>
</li>
<li><a href="#passthroughs">42. Passthroughs</a>
<ul class="sectlevel2">
<li><a href="#pass-macros">42.1. Passthrough Macros</a></li>
<li><a href="#pass-blocks">42.2. Passthrough Blocks</a></li>
</ul>
</li>
<li><a href="#open-blocks">43. Open Blocks</a></li>
</ul>
</li>
<li><a href="#enriching-your-content">Enriching Your Content</a>
<ul class="sectlevel1">
<li><a href="#stem">44. Equations and Formulas</a>
<ul class="sectlevel2">
<li><a href="#stem-in">44.1. Inline Stem Content</a></li>
<li><a href="#stem-bl">44.2. Block Stem Content</a></li>
<li><a href="#using-multiple-stem-interpreters">44.3. Using Multiple Stem Interpreters</a></li>
<li><a href="#stem-docbook">44.4. Enabling STEM expressions in the DocBook Toolchain</a></li>
</ul>
</li>
<li><a href="#user-interface-macros">45. User Interface Macros</a></li>
<li><a href="#icons">46. Icons</a></li>
<li><a href="#source-code-blocks">47. Syntax Highlighting Source Code</a>
<ul class="sectlevel2">
<li><a href="#pygments">47.1. Pygments</a></li>
<li><a href="#coderay">47.2. CodeRay</a></li>
<li><a href="#highlight-js">47.3. highlight.js</a></li>
</ul>
</li>
<li><a href="#callouts">48. Callouts</a>
<ul class="sectlevel2">
<li><a href="#copy-and-paste-friendly-callouts">48.1. Copy and Paste Friendly Callouts</a></li>
<li><a href="#callout-icons">48.2. Callout Icons</a></li>
</ul>
</li>
<li><a href="#conditional-preprocessor-directives">49. Conditional Preprocessor Directives</a></li>
<li><a href="#docinfo-file">50. Docinfo Files</a></li>
<li><a href="#counters">51. Counters</a></li>
</ul>
</li>
<li><a href="#structuring-navigating-and-referencing-your-content">Structuring, Navigating, and Referencing Your Content</a>
<ul class="sectlevel1">
<li><a href="#title-page">52. Title Page</a></li>
<li><a href="#user-colophon">53. Colophon</a></li>
<li><a href="#user-toc">54. Table of Contents</a>
<ul class="sectlevel2">
<li><a href="#manual-placement">54.1. In-Document Placement</a></li>
<li><a href="#left-or-right-column-layout">54.2. Side Column Placement</a></li>
<li><a href="#user-toc-title">54.3. Title</a></li>
<li><a href="#user-toc-levels">54.4. Levels</a></li>
<li><a href="#using-a-toc-with-embeddable-html">54.5. Using a TOC with Embeddable HTML</a></li>
<li><a href="#table-of-contents-summary">54.6. Table of Contents Summary</a></li>
</ul>
</li>
<li><a href="#user-abstract">55. Abstract</a></li>
<li><a href="#user-preface">56. Preface</a></li>
<li><a href="#user-dedication">57. Dedication</a></li>
<li><a href="#book-parts-and-chapters">58. Book Parts and Chapters</a></li>
<li><a href="#user-appendix">59. Appendix</a></li>
<li><a href="#user-glossary">60. Glossary</a></li>
<li><a href="#user-biblio">61. Bibliography</a></li>
<li><a href="#user-index">62. Index</a></li>
<li><a href="#user-footnotes">63. Footnotes</a></li>
</ul>
</li>
<li><a href="#processing-your-content">Processing Your Content</a>
<ul class="sectlevel1">
<li><a href="#selecting-an-output-format">64. Selecting an Output Format</a></li>
<li><a href="#html">65. HTML</a>
<ul class="sectlevel2">
<li><a href="#using-the-command-line">65.1. Using the Command Line</a></li>
<li><a href="#using-the-ruby-api-2">65.2. Using the Ruby API</a></li>
<li><a href="#styling-the-html-with-css">65.3. Styling the HTML with CSS</a></li>
<li><a href="#managing-images">65.4. Managing Images</a></li>
<li><a href="#hl-css">65.5. CodeRay and Pygments Stylesheets</a></li>
</ul>
</li>
<li><a href="#xhtml">66. XHTML</a></li>
<li><a href="#docbook">67. DocBook</a></li>
<li><a href="#man-pages">68. Man Pages</a></li>
<li><a href="#pdfs">69. PDFs</a></li>
<li><a href="#preview-your-content">70. Preview Your Content</a>
<ul class="sectlevel2">
<li><a href="#guard-live-viewer">70.1. Guard/Live Viewer</a></li>
</ul>
</li>
<li><a href="#process-multiple-source-files-from-the-cli">71. Process Multiple Source Files from the CLI</a></li>
<li><a href="#specifying-an-output-file">72. Specifying an Output File</a></li>
<li><a href="#running-asciidoctor-securely">73. Running Asciidoctor Securely</a>
<ul class="sectlevel2">
<li><a href="#set-the-safe-mode-in-the-cli">73.1. Set the Safe Mode in the CLI</a></li>
<li><a href="#set-the-safe-mode-in-the-api">73.2. Set the Safe Mode in the API</a></li>
<li><a href="#set-attributes-based-on-the-safe-mode">73.3. Set Attributes Based on the Safe Mode</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#customizing-your-output">Customizing Your Output</a>
<ul class="sectlevel1">
<li><a href="#custom-themes">74. Custom Themes</a>
<ul class="sectlevel2">
<li><a href="#creating-a-theme">74.1. Creating a Theme</a></li>
<li><a href="#applying-a-theme">74.2. Applying a Theme</a></li>
</ul>
</li>
<li><a href="#stylesheet-factory">75. Stylesheet Factory</a>
<ul class="sectlevel2">
<li><a href="#setting-up-the-factory">75.1. Setting up the Factory</a></li>
<li><a href="#applying-a-stylesheet">75.2. Applying a Stylesheet</a></li>
<li><a href="#generate-an-html-document">75.3. Generate an HTML Document</a></li>
<li><a href="#external-preview">75.4. External Preview</a></li>
</ul>
</li>
<li><a href="#slideshows">76. Slideshows</a>
<ul class="sectlevel2">
<li><a href="#deckjs">76.1. Deck.js</a></li>
</ul>
</li>
<li><a href="#custom-backends">77. Custom Backends</a>
<ul class="sectlevel2">
<li><a href="#creating-a-backend">77.1. Creating a Backend</a></li>
</ul>
</li>
<li><a href="#language-support">78. Using Asciidoctor with Other Languages</a></li>
</ul>
</li>
<li><a href="#publishing-your-content">Publishing Your Content</a>
<ul class="sectlevel1">
<li><a href="#repositories">79. Repositories</a></li>
<li><a href="#static-website-generators">80. Static Website Generators</a>
<ul class="sectlevel2">
<li><a href="#front-matter-added-for-static-site-generators">80.1. Front Matter Added for Static Site Generators</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#api">Using Asciidoctor&#8217;s API</a>
<ul class="sectlevel1">
<li><a href="#load-and-render-a-file-using-the-api">81. Load and Render a File Using the API</a>
<ul class="sectlevel2">
<li><a href="#render-strings">81.1. Render Strings</a></li>
</ul>
</li>
<li><a href="#provide-custom-templates">82. Provide Custom Templates</a></li>
</ul>
</li>
<li><a href="#extensions">Extensions</a>
<ul class="sectlevel1">
<li><a href="#extension-points">83. Extension Points</a></li>
<li><a href="#example-extensions">84. Example Extensions</a>
<ul class="sectlevel2">
<li><a href="#preprocessor-example">84.1. Preprocessor Example</a></li>
<li><a href="#tree-processor-example">84.2. Tree Processor Example</a></li>
<li><a href="#postprocessor-example">84.3. Postprocessor Example</a></li>
<li><a href="#docinfo-processor-example">84.4. Docinfo Processor Example</a></li>
<li><a href="#block-processor-example">84.5. Block Processor Example</a></li>
<li><a href="#block-macro-processor-example">84.6. Block Macro Processor Example</a></li>
<li><a href="#inline-macro-processor-example">84.7. Inline Macro Processor Example</a></li>
<li><a href="#include-processor-example">84.8. Include Processor Example</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#build-integrations-and-implementations">Build Integrations and Implementations</a>
<ul class="sectlevel1">
<li><a href="#java">85. Java</a></li>
<li><a href="#gradle">86. Gradle</a></li>
<li><a href="#maven">87. Maven</a></li>
<li><a href="#apache-ant">88. Apache Ant</a></li>
<li><a href="#javadoc">89. JavaDoc</a></li>
<li><a href="#javascript">90. JavaScript</a></li>
<li><a href="#yard">91. Yard</a></li>
<li><a href="#rdoc">92. Rdoc</a></li>
</ul>
</li>
<li><a href="#conversions-and-migrations">Conversions and Migrations</a>
<ul class="sectlevel1">
<li><a href="#convert-docbook-xml-to-asciidoc">93. Convert DocBook XML to AsciiDoc</a></li>
<li><a href="#convert-markdown-to-asciidoc">94. Convert Markdown to AsciiDoc</a></li>
<li><a href="#convert-confluence-xhtml-to-asciidoc">95. Convert Confluence XHTML to AsciiDoc</a></li>
<li><a href="#convert-ms-word-to-asciidoc">96. Convert MS Word to AsciiDoc</a></li>
</ul>
</li>
<li><a href="#resources">Resources</a>
<ul class="sectlevel1">
<li><a href="#copyright-and-license">97. Copyright and License</a></li>
<li><a href="#authors">98. Authors</a>
<ul class="sectlevel2">
<li><a href="#glossary">98.1. Glossary</a></li>
<li><a href="#attribute-catalog">Appendix A: Catalog of Document Attributes</a></li>
<li><a href="#cli-options">Appendix B: CLI Options</a></li>
<li><a href="#ruby-api-options">Appendix C: Ruby API Options</a></li>
<li><a href="#app-messages">Appendix D: Application Messages</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="title">This document is under active development and discussion!</div>
<div class="paragraph">
<p>If you find errors or omissions in this document, please don&#8217;t hesitate to <a href="https://github.com/asciidoctor/asciidoctor.org/issues">submit an issue or open a pull request</a> with a fix.
We also encourage you to ask questions and discuss any aspects of the project on the <a href="http://discuss.asciidoctor.org">mailing list</a> or <a href="irc://irc.freenode.org/#asciidoctor">IRC</a>.
New contributors are always welcome!</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>This manual assumes you are using Asciidoctor to produce and render your document.
Asciidoctor implements more syntax, attributes and functions than the legacy AsciiDoc.py processor.
<a href="#migrating-from-asciidoc-python">[migrating-from-asciidoc-python]</a> lists which features are available to the Asciidoctor and AsciiDoc processors.</p>
</div>
</div>
</div>
<h1 id="introduction-to-asciidoctor" class="sect0"><a class="anchor" href="#introduction-to-asciidoctor"></a><a class="link" href="#introduction-to-asciidoctor">Introduction to Asciidoctor</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/433">Issue 433</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/about-asciidoctor.adoc[]</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="asciidoctor-s-most-notable-benefits"><a class="anchor" href="#asciidoctor-s-most-notable-benefits"></a><a class="link" href="#asciidoctor-s-most-notable-benefits">1.1. Asciidoctor&#8217;s Most Notable Benefits</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/benefits.adoc[]</p>
</div>
<div class="sect3">
<h4 id="asciidoc-syntax-processing"><a class="anchor" href="#asciidoc-syntax-processing"></a><a class="link" href="#asciidoc-syntax-processing">1.1.1. AsciiDoc Syntax Processing</a></h4>
<div class="paragraph">
<p>Asciidoctor reads and parses text written in the AsciiDoc syntax, then feeds the parse tree into a set of built-in templates to produce HTML5, PDF, DocBook 5, etc.
You have the option of writing your own converter or providing <a href="https://github.com/rtomayko/tilt">Tilt</a>-supported templates to customize the generated output or produce alternative formats.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Asciidoctor is a drop-in replacement for the original AsciiDoc Python processor (<code>asciidoc.py</code>).
The Asciidoctor test suite has &gt; 1,500 tests to ensure compatibility with the AsciiDoc syntax.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>In addition to the standard AsciiDoc syntax, Asciidoctor recognizes additional markup and formatting options, such as font-based icons (e.g., <code>icon:fire[]</code>) and UI elements (e.g., <code>btn:[Save]</code>).
Asciidoctor also offers a modern, responsive theme based on <a href="http://foundation.zurb.com">Foundation</a> to style the HTML5 output.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="compared-to-markdown"><a class="anchor" href="#compared-to-markdown"></a><a class="link" href="#compared-to-markdown">1.2. Compared to MarkDown</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/asciidoc-vs-markdown.adoc[]</p>
</div>
</div>
<h1 id="quick-starts" class="sect0"><a class="anchor" href="#quick-starts"></a><a class="link" href="#quick-starts">Quick Starts</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Section Pending
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="installation-quick-start"><a class="anchor" href="#installation-quick-start"></a><a class="link" href="#installation-quick-start">1. Installation Quick Start</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/436">Issue 436</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="usage-quick-start"><a class="anchor" href="#usage-quick-start"></a><a class="link" href="#usage-quick-start">2. Usage Quick Start</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/437">Issue 437</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="using-the-command-line-interface"><a class="anchor" href="#using-the-command-line-interface"></a><a class="link" href="#using-the-command-line-interface">2.1. Using the Command Line Interface</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/command-line-usage.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="using-the-ruby-api"><a class="anchor" href="#using-the-ruby-api"></a><a class="link" href="#using-the-ruby-api">2.2. Using the Ruby API</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/api-intro.adoc[]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/load-render-api.adoc[]</p>
</div>
<div class="paragraph">
<p>You can also use the API to <a href="#render-strings">render strings</a> and <a href="#provide-custom-templates">load custom templates</a>.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="syntax-quick-start"><a class="anchor" href="#syntax-quick-start"></a><a class="link" href="#syntax-quick-start">3. Syntax Quick Start</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/441">Issue 441</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="custom-output-quick-start"><a class="anchor" href="#custom-output-quick-start"></a><a class="link" href="#custom-output-quick-start">4. Custom Output Quick Start</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/442">Issue 442</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<h1 id="getting-started" class="sect0"><a class="anchor" href="#getting-started"></a><a class="link" href="#getting-started">Getting Started</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Section Pending
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="system-requirements"><a class="anchor" href="#system-requirements"></a><a class="link" href="#system-requirements">5. System Requirements</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=systemreq]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="installing-the-asciidoctor-ruby-gem"><a class="anchor" href="#installing-the-asciidoctor-ruby-gem"></a><a class="link" href="#installing-the-asciidoctor-ruby-gem">6. Installing the Asciidoctor Ruby Gem</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=intro]</p>
</div>
<div class="sect2">
<h3 id="install-using-code-gem-code"><a class="anchor" href="#install-using-code-gem-code"></a><a class="link" href="#install-using-code-gem-code">6.1. Install using <code>gem</code></a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=gem]</p>
</div>
</div>
<div class="sect2">
<h3 id="install-using-bundler"><a class="anchor" href="#install-using-bundler"></a><a class="link" href="#install-using-bundler">6.2. Install using Bundler</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=bundler]</p>
</div>
</div>
<div class="sect2">
<h3 id="install-using-code-yum-code-or-code-dnf-code-on-fedora"><a class="anchor" href="#install-using-code-yum-code-or-code-dnf-code-on-fedora"></a><a class="link" href="#install-using-code-yum-code-or-code-dnf-code-on-fedora">6.3. Install using <code>yum</code> or <code>dnf</code> on Fedora</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=yum]</p>
</div>
</div>
<div class="sect2">
<h3 id="install-using-code-apt-get-code-on-debian-or-ubuntu"><a class="anchor" href="#install-using-code-apt-get-code-on-debian-or-ubuntu"></a><a class="link" href="#install-using-code-apt-get-code-on-debian-or-ubuntu">6.4. Install using <code>apt-get</code> on Debian or Ubuntu</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=aptget]</p>
</div>
</div>
<div class="sect2">
<h3 id="install-using-code-apk-code-on-alpine-linux"><a class="anchor" href="#install-using-code-apk-code-on-alpine-linux"></a><a class="link" href="#install-using-code-apk-code-on-alpine-linux">6.5. Install using <code>apk</code> on Alpine Linux</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=apk]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="upgrading-the-asciidoctor-ruby-gem"><a class="anchor" href="#upgrading-the-asciidoctor-ruby-gem"></a><a class="link" href="#upgrading-the-asciidoctor-ruby-gem">7. Upgrading the Asciidoctor Ruby Gem</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/install-upgrade-asciidoctor.adoc[tag=upgrade]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="extensions-and-integrations"><a class="anchor" href="#extensions-and-integrations"></a><a class="link" href="#extensions-and-integrations">8. Extensions and Integrations</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>See <a href="#extensions">Extensions</a>.</p>
</div>
</div>
</div>
<h1 id="terms-and-concepts" class="sect0"><a class="anchor" href="#terms-and-concepts"></a><a class="link" href="#terms-and-concepts">Terms and Concepts</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="paragraph">
<p>All of the content in an Asciidoctor document, including lines of text, predefined styles, and processing commands, is classified as either a block or an inline element.
Within each of these elements are an array of styles, options, and functions that can be applied to your content.</p>
</div>
<div class="paragraph">
<p>This section will provide you with an overview of what each of these elements and sub-elements are and the basic syntax and rules for using them.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="elements"><a class="anchor" href="#elements"></a><a class="link" href="#elements">9. Elements</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/element.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="macros"><a class="anchor" href="#macros"></a><a class="link" href="#macros">10. Macros</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/443">Issue 443</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="formatting-marks"><a class="anchor" href="#formatting-marks"></a><a class="link" href="#formatting-marks">11. Formatting Marks</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/formatting-marks.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="attributes"><a class="anchor" href="#attributes"></a><a class="link" href="#attributes">12. Attributes</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr.adoc[tag=intro]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr.adoc[tag=attributesyntax]</p>
</div>
<div class="sect2">
<h3 id="attribute-assignment-precedence"><a class="anchor" href="#attribute-assignment-precedence"></a><a class="link" href="#attribute-assignment-precedence">12.1. Attribute Assignment Precedence</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr.adoc[tag=order]</p>
</div>
</div>
<div class="sect2">
<h3 id="using-attributes-set-assign-and-reference"><a class="anchor" href="#using-attributes-set-assign-and-reference"></a><a class="link" href="#using-attributes-set-assign-and-reference">12.2. Using Attributes: Set, Assign, and Reference</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-use.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="setting-attributes-on-a-document"><a class="anchor" href="#setting-attributes-on-a-document"></a><a class="link" href="#setting-attributes-on-a-document">12.3. Setting Attributes on a Document</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-doc.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="setting-attributes-on-an-element"><a class="anchor" href="#setting-attributes-on-an-element"></a><a class="link" href="#setting-attributes-on-an-element">12.4. Setting Attributes on an Element</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-element.adoc[tag=intro]</p>
</div>
<div class="sect3">
<h4 id="positional-attribute"><a class="anchor" href="#positional-attribute"></a><a class="link" href="#positional-attribute">12.4.1. Positional Attribute</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-element.adoc[tag=pos]</p>
</div>
</div>
<div class="sect3">
<h4 id="named-attribute"><a class="anchor" href="#named-attribute"></a><a class="link" href="#named-attribute">12.4.2. Named Attribute</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-element.adoc[tag=name]</p>
</div>
</div>
<div class="sect3">
<h4 id="style"><a class="anchor" href="#style"></a><a class="link" href="#style">12.4.3. Style</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-style.adoc[tag=intro]</p>
</div>
</div>
<div class="sect3">
<h4 id="id"><a class="anchor" href="#id"></a><a class="link" href="#id">12.4.4. Id</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-style.adoc[tag=id]</p>
</div>
<div class="sect4">
<h5 id="block-assignment"><a class="anchor" href="#block-assignment"></a><a class="link" href="#block-assignment">Block Assignment</a></h5>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-style.adoc[tag=bl]</p>
</div>
</div>
<div class="sect4">
<h5 id="inline-assignment"><a class="anchor" href="#inline-assignment"></a><a class="link" href="#inline-assignment">Inline Assignment</a></h5>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-style.adoc[tag=in]</p>
</div>
</div>
</div>
<div class="sect3">
<h4 id="role"><a class="anchor" href="#role"></a><a class="link" href="#role">12.4.5. Role</a></h4>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Section introduction pending
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>An element can be assigned numerous roles.</p>
</div>
<div class="sect4">
<h5 id="block-assignment-2"><a class="anchor" href="#block-assignment-2"></a><a class="link" href="#block-assignment-2">Block Assignment</a></h5>
<div class="paragraph">
<p>In an attribute list, there are two ways to assign a role attribute to a block element.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Prefixing the name with a dot (<code>.</code>).</p>
</li>
<li>
<p>Specifying the name with <code>role=&lt;name&gt;</code>.</p>
</li>
</ol>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="asciidoc">[.summary]
* Review 1
* Review 2</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="asciidoc">[role=&quot;summary&quot;]
* Review 1
* Review 2</code></pre>
</div>
</div>
<div class="paragraph">
<p>To specify multiple roles using the shorthand syntax, separate them by dots.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="asciidoc">[.summary.incremental]
* Review 1
* Review 2</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="asciidoc">[role=&quot;summary,incremental&quot;]
* Review 1
* Review 2</code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="inline-assignment-2"><a class="anchor" href="#inline-assignment-2"></a><a class="link" href="#inline-assignment-2">Inline Assignment</a></h5>
<div class="paragraph">
<p>The role (<code>.</code>) shorthand can be used on inline quoted text.</p>
</div>
<div class="listingblock">
<div class="title">Quoted text with role assignments using traditional AsciiDoc syntax</div>
<div class="content">
<pre>[big goal]*free the world*</pre>
</div>
</div>
<div class="listingblock">
<div class="title">Quoted text with role assignments using Asciidoctor shorthand</div>
<div class="content">
<pre>[.big.goal]*free the world*</pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
The attribute list preceding formatted text can be escaped using a backslash (e.g., <code>\[role]*bold*</code>).
In this case, the text will still be formatted, but the attribute list will be unescaped and output verbatim.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<div class="title">Role-playing for text enclosed in backticks</div>
<p>To align with other formatted (i.e., quoted) text in AsciiDoc, roles can now be assigned to text enclosed in backticks.</p>
</div>
<div class="paragraph">
<p>Given:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="asciidoc">[rolename]`monospace text`</code></pre>
</div>
</div>
<div class="paragraph">
<p>the following HTML is produced:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="html"><span class="tag">&lt;code</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">rolename</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>monospace text<span class="tag">&lt;/code&gt;</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Using the shorthand notation, an id (i.e., anchor) can also be specified:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="asciidoc">[#idname.rolename]`monospace text`</code></pre>
</div>
</div>
<div class="paragraph">
<p>which produces:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="html"><span class="tag">&lt;a</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">idname</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span><span class="tag">&lt;/a&gt;</span><span class="tag">&lt;code</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">rolename</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>monospace text<span class="tag">&lt;/code&gt;</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="options"><a class="anchor" href="#options"></a><a class="link" href="#options">12.4.6. Options</a></h4>
<div class="paragraph">
<p>The options attribute is a versatile named attribute that can contain a comma separated list of values.</p>
</div>
<div class="paragraph">
<p>It can also be defined globally with an attribute entry.</p>
</div>
<div class="sect4">
<h5 id="block-assignment-3"><a class="anchor" href="#block-assignment-3"></a><a class="link" href="#block-assignment-3">Block Assignment</a></h5>
<div class="paragraph">
<p>In an attribute list, there are three ways to assign an options attribute to a block element.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Prefixing the value with a percent sign (<code>%</code>).</p>
</li>
<li>
<p>Specifying the value with <code>opts=&lt;name&gt;</code></p>
</li>
<li>
<p>Specifying the value with <code>options=&lt;name&gt;</code>.</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>Consider a table block with the three option values <code>header</code>, <code>footer</code>, and <code>autowidth</code>.</p>
</div>
<div class="paragraph">
<p>Here&#8217;s how the options are assigned to the table using the shorthand notation (<code>%</code>).</p>
</div>
<div class="listingblock">
<div class="title">Shorthand Asciidoctor syntax</div>
<div class="content">
<pre>[%header%footer%autowidth]
|===
| Cell A | Cell B
|===</pre>
</div>
</div>
<div class="paragraph">
<p>Here&#8217;s how the options are assigned to the table using <code>options</code>.</p>
</div>
<div class="listingblock">
<div class="title">Traditional AsciiDoc syntax</div>
<div class="content">
<pre>[options="header,footer,autowidth"]
|===
| Cell A | Cell B
|===</pre>
</div>
</div>
<div class="paragraph">
<p>Let&#8217;s consider the options when combined with other attributes.</p>
</div>
<div class="listingblock">
<div class="title">Shorthand Asciidoctor block syntax</div>
<div class="content">
<pre>[horizontal.properties%step]
property 1:: does stuff
property 2:: does different stuff</pre>
</div>
</div>
<div class="listingblock">
<div class="title">Traditional AsciiDoc block syntax</div>
<div class="content">
<pre>[horizontal, role="properties", options="step"]
property 1:: does stuff
property 2:: does different stuff</pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="assigning-document-attributes-inline"><a class="anchor" href="#assigning-document-attributes-inline"></a><a class="link" href="#assigning-document-attributes-inline">12.5. Assigning Document Attributes Inline</a></h3>
<div class="paragraph">
<p>Document attributes can be assigned using the following syntax:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>{set:&lt;attrname&gt;[!][:&lt;value&gt;]}</pre>
</div>
</div>
<div class="paragraph">
<p>For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="asciidoc">{set:sourcedir:src/main/java}</code></pre>
</div>
</div>
<div class="paragraph">
<p>is effectively the same as:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>:sourcedir: src/main/java</pre>
</div>
</div>
<div class="paragraph">
<p>This is important for being able to assign document attributes in places where attribute entry lines are not normally processed, such as in a table cell.</p>
</div>
</div>
<div class="sect2">
<h3 id="attribute-conventions"><a class="anchor" href="#attribute-conventions"></a><a class="link" href="#attribute-conventions">12.6. Attribute Conventions</a></h3>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/444">Issue 444</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="sect3">
<h4 id="catch-a-missing-or-undefined-attribute"><a class="anchor" href="#catch-a-missing-or-undefined-attribute"></a><a class="link" href="#catch-a-missing-or-undefined-attribute">12.6.1. Catch a Missing or Undefined Attribute</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attr-miss.adoc[]</p>
</div>
</div>
</div>
</div>
</div>
<h1 id="building-a-document" class="sect0"><a class="anchor" href="#building-a-document"></a><a class="link" href="#building-a-document">Building a Document</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Introduction Pending
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="text-editor"><a class="anchor" href="#text-editor"></a><a class="link" href="#text-editor">13. Text Editor</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/text-editor.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="document-types"><a class="anchor" href="#document-types"></a><a class="link" href="#document-types">14. Document Types</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/doctype.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="basic-document-anatomy"><a class="anchor" href="#basic-document-anatomy"></a><a class="link" href="#basic-document-anatomy">15. Basic Document Anatomy</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/445">Issue 445</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="doc-header"><a class="anchor" href="#doc-header"></a><a class="link" href="#doc-header">16. Header</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/header-intro.adoc[]</p>
</div>
<div class="sect2">
<h3 id="document-title"><a class="anchor" href="#document-title"></a><a class="link" href="#document-title">16.1. Document Title</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/header-title.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="author-and-email"><a class="anchor" href="#author-and-email"></a><a class="link" href="#author-and-email">16.2. Author and Email</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/author.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="revision-number-date-and-remark"><a class="anchor" href="#revision-number-date-and-remark"></a><a class="link" href="#revision-number-date-and-remark">16.3. Revision Number, Date and Remark</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/revision.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="subtitle-partitioning"><a class="anchor" href="#subtitle-partitioning"></a><a class="link" href="#subtitle-partitioning">16.4. Subtitle Partitioning</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subtitle.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="metadata"><a class="anchor" href="#metadata"></a><a class="link" href="#metadata">16.5. Metadata</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/meta.adoc[tag=intro]</p>
</div>
<div class="sect3">
<h4 id="description"><a class="anchor" href="#description"></a><a class="link" href="#description">16.5.1. Description</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/meta.adoc[tag=desc]</p>
</div>
</div>
<div class="sect3">
<h4 id="keywords"><a class="anchor" href="#keywords"></a><a class="link" href="#keywords">16.5.2. Keywords</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/meta.adoc[tag=key]</p>
</div>
</div>
<div class="sect3">
<h4 id="alternate-title"><a class="anchor" href="#alternate-title"></a><a class="link" href="#alternate-title">16.5.3. Alternate Title</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/meta.adoc[tag=atitle]</p>
</div>
</div>
<div class="sect3">
<h4 id="custom-metadata-styles-and-functions"><a class="anchor" href="#custom-metadata-styles-and-functions"></a><a class="link" href="#custom-metadata-styles-and-functions">16.5.4. Custom Metadata, Styles and Functions</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/meta.adoc[tag=cmeta]</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="header-summary"><a class="anchor" href="#header-summary"></a><a class="link" href="#header-summary">16.6. Header Summary</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-header.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="doc-preamble"><a class="anchor" href="#doc-preamble"></a><a class="link" href="#doc-preamble">17. Preamble</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/preamble-tut.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="sections"><a class="anchor" href="#sections"></a><a class="link" href="#sections">18. Sections</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sections.adoc[tag=intro]</p>
</div>
<div class="sect2">
<h3 id="titles-as-html-headings"><a class="anchor" href="#titles-as-html-headings"></a><a class="link" href="#titles-as-html-headings">18.1. Titles as HTML Headings</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sections.adoc[tag=heading]</p>
</div>
</div>
<div class="sect2">
<h3 id="auto-generated-ids"><a class="anchor" href="#auto-generated-ids"></a><a class="link" href="#auto-generated-ids">18.2. Auto-generated IDs</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sections.adoc[tag=autoid]</p>
</div>
</div>
<div class="sect2">
<h3 id="custom-ids"><a class="anchor" href="#custom-ids"></a><a class="link" href="#custom-ids">18.3. Custom IDs</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sections.adoc[tag=custom-id]</p>
</div>
</div>
<div class="sect2">
<h3 id="links"><a class="anchor" href="#links"></a><a class="link" href="#links">18.4. Links</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sections.adoc[tag=link]</p>
</div>
</div>
<div class="sect2">
<h3 id="anchors"><a class="anchor" href="#anchors"></a><a class="link" href="#anchors">18.5. Anchors</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sections.adoc[tag=anchor]</p>
</div>
</div>
<div class="sect2">
<h3 id="numbering"><a class="anchor" href="#numbering"></a><a class="link" href="#numbering">18.6. Numbering</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sections.adoc[tag=number]</p>
</div>
</div>
<div class="sect2">
<h3 id="discrete-headings"><a class="anchor" href="#discrete-headings"></a><a class="link" href="#discrete-headings">18.7. Discrete Headings (aka Floating Titles)</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/discrete-heading.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="section-styles"><a class="anchor" href="#section-styles"></a><a class="link" href="#section-styles">18.8. Section Styles</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/section-styles.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="sections-summary"><a class="anchor" href="#sections-summary"></a><a class="link" href="#sections-summary">18.9. Sections Summary</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-section.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="blocks"><a class="anchor" href="#blocks"></a><a class="link" href="#blocks">19. Blocks</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/block.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="paragraph"><a class="anchor" href="#paragraph"></a><a class="link" href="#paragraph">20. Paragraph</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/para.adoc[]</p>
</div>
<div class="sect2">
<h3 id="line-breaks"><a class="anchor" href="#line-breaks"></a><a class="link" href="#line-breaks">20.1. Line Breaks</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/para-line-break.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="lead-style"><a class="anchor" href="#lead-style"></a><a class="link" href="#lead-style">20.2. Lead Style</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/para-lead.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="text-formatting"><a class="anchor" href="#text-formatting"></a><a class="link" href="#text-formatting">21. Text Formatting</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/text.adoc[]</p>
</div>
<div class="sect2">
<h3 id="bold-and-italic"><a class="anchor" href="#bold-and-italic"></a><a class="link" href="#bold-and-italic">21.1. Bold and Italic</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/text-bold-italic.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="curved"><a class="anchor" href="#curved"></a><a class="link" href="#curved">21.2. Quotation Marks and Apostrophes</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/text-quote-apos.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="subscript-and-superscript"><a class="anchor" href="#subscript-and-superscript"></a><a class="link" href="#subscript-and-superscript">21.3. Subscript and Superscript</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/text-sub-sup.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="mono"><a class="anchor" href="#mono"></a><a class="link" href="#mono">21.4. Monospace</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/text-mono.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="custom-styling-with-attributes"><a class="anchor" href="#custom-styling-with-attributes"></a><a class="link" href="#custom-styling-with-attributes">21.5. Custom Styling With Attributes</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/text-css.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="unordered-lists"><a class="anchor" href="#unordered-lists"></a><a class="link" href="#unordered-lists">22. Unordered Lists</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/ulist.adoc[]</p>
</div>
<div class="sect2">
<h3 id="nested"><a class="anchor" href="#nested"></a><a class="link" href="#nested">22.1. Nested</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/ulist-nested.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="complex-list-content"><a class="anchor" href="#complex-list-content"></a><a class="link" href="#complex-list-content">22.2. Complex List Content</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/ulist-complex.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="custom-markers"><a class="anchor" href="#custom-markers"></a><a class="link" href="#custom-markers">22.3. Custom Markers</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/ulist-marker.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="checklist"><a class="anchor" href="#checklist"></a><a class="link" href="#checklist">22.4. Checklist</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/checklist.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="summary"><a class="anchor" href="#summary"></a><a class="link" href="#summary">22.5. Summary</a></h3>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/466">Issue 466</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="ordered-lists"><a class="anchor" href="#ordered-lists"></a><a class="link" href="#ordered-lists">23. Ordered Lists</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/o-list.adoc[]</p>
</div>
<div class="sect2">
<h3 id="nested-2"><a class="anchor" href="#nested-2"></a><a class="link" href="#nested-2">23.1. Nested</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/o-list-nest.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="numbering-styles"><a class="anchor" href="#numbering-styles"></a><a class="link" href="#numbering-styles">23.2. Numbering Styles</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/o-list-num.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="summary-2"><a class="anchor" href="#summary-2"></a><a class="link" href="#summary-2">23.3. Summary</a></h3>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/446">Issue 446</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="labeled-list"><a class="anchor" href="#labeled-list"></a><a class="link" href="#labeled-list">24. Labeled List</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/dlist.adoc[]</p>
</div>
<div class="sect2">
<h3 id="question-and-answer-style-list"><a class="anchor" href="#question-and-answer-style-list"></a><a class="link" href="#question-and-answer-style-list">24.1. Question and Answer Style List</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/dlist-qa.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="summary-3"><a class="anchor" href="#summary-3"></a><a class="link" href="#summary-3">24.2. Summary</a></h3>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/447">Issue 447</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="tables"><a class="anchor" href="#tables"></a><a class="link" href="#tables">25. Tables</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/table.adoc[]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/table-col.adoc[]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/table-cell.adoc[]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/table-formatting.adoc[]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/table-data.adoc[]</p>
</div>
<div class="sect2">
<h3 id="summary-tables"><a class="anchor" href="#summary-tables"></a><a class="link" href="#summary-tables">25.1. Summary</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-table.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="horizontal-rules"><a class="anchor" href="#horizontal-rules"></a><a class="link" href="#horizontal-rules">26. Horizontal Rules</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/hr.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="page-break"><a class="anchor" href="#page-break"></a><a class="link" href="#page-break">27. Page Break</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/page-break.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="url"><a class="anchor" href="#url"></a><a class="link" href="#url">28. URLs</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/url.adoc[]</p>
</div>
<div class="sect2">
<h3 id="link-to-relative-files"><a class="anchor" href="#link-to-relative-files"></a><a class="link" href="#link-to-relative-files">28.1. Link to Relative Files</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/url-relative.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="summary-4"><a class="anchor" href="#summary-4"></a><a class="link" href="#summary-4">28.2. Summary</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-url.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="xref"><a class="anchor" href="#xref"></a><a class="link" href="#xref">29. Cross References</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>A link to another location within the current AsciiDoc document or in another AsciiDoc document is called a <em class="term">cross reference</em> (also referred to as an <em>xref</em>).
To create a cross reference, you first need to define the location where the reference will point (i.e., the anchor).
Then, you need to use one of the forms of the inline xref macro to create a reference to that location.
From there, you can customize the text of the reference in various ways.</p>
</div>
<div class="sect2">
<h3 id="automatic-anchors"><a class="anchor" href="#automatic-anchors"></a><a class="link" href="#automatic-anchors">29.1. Automatic Anchors</a></h3>
<div class="paragraph">
<p>It&#8217;s important to understand that many anchors are already defined for you.
Using default settings, Asciidoctor automatically creates an anchor for every section and discrete heading.
It does so by generating an ID for that section (or discrete heading) and registering that ID in the references catalog.
You can then use that ID as the target of an cross reference.</p>
</div>
<div class="paragraph">
<p>For example, considering the following section.</p>
</div>
<div class="listingblock">
<div class="content">
<pre>= Section Title</pre>
</div>
</div>
<div class="paragraph">
<p>Asciidoctor automatically assigns the ID <code>_section_title</code> to this section, which you can then use as the target of an xref to create a reference to this section.
You can also customize how this ID is generated.
Refer to <a href="#auto-generated-ids">Auto-generated IDs</a> for more information about how Asciidoctor generates these IDs.</p>
</div>
<div class="paragraph">
<p>If you&#8217;re refering to a content element other than a section, you&#8217;ll need to define an anchor on that element explicitly.
Read on to learn how.</p>
</div>
</div>
<div class="sect2">
<h3 id="anchordef"><a class="anchor" href="#anchordef"></a><a class="link" href="#anchordef">29.2. Defining an Anchor</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/xref-anchor.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="internal-cross-references"><a class="anchor" href="#internal-cross-references"></a><a class="link" href="#internal-cross-references">29.3. Internal Cross References</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/xref.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="customizing-the-cross-reference-text"><a class="anchor" href="#customizing-the-cross-reference-text"></a><a class="link" href="#customizing-the-cross-reference-text">29.4. Customizing the Cross Reference Text</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/xrefstyle.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="inter-document-cross-references"><a class="anchor" href="#inter-document-cross-references"></a><a class="link" href="#inter-document-cross-references">29.5. Inter-document Cross References</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/xref-interdoc.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="include-directive"><a class="anchor" href="#include-directive"></a><a class="link" href="#include-directive">30. Include Directive</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/include-directive.adoc[]</p>
</div>
<div class="sect2">
<h3 id="include-partial"><a class="anchor" href="#include-partial"></a><a class="link" href="#include-partial">30.1. Select Portions of a Document to Include</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/include-lines-tags.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="normalize-block-indentation"><a class="anchor" href="#normalize-block-indentation"></a><a class="link" href="#normalize-block-indentation">30.2. Normalize Block Indentation</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/indent-include.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="include-uri"><a class="anchor" href="#include-uri"></a><a class="link" href="#include-uri">30.3. Include Content from a URI</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/uri-include.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="include-multiple"><a class="anchor" href="#include-multiple"></a><a class="link" href="#include-multiple">30.4. Include a File Multiple Times in the Same Document</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/multiple-include.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="images"><a class="anchor" href="#images"></a><a class="link" href="#images">31. Images</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/image.adoc[]</p>
</div>
<div class="sect2">
<h3 id="setting-the-location-of-images"><a class="anchor" href="#setting-the-location-of-images"></a><a class="link" href="#setting-the-location-of-images">31.1. Setting the Location of Images</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/image-dir.adoc[]</p>
</div>
<div class="sect3">
<h4 id="include-images-by-full-url"><a class="anchor" href="#include-images-by-full-url"></a><a class="link" href="#include-images-by-full-url">31.1.1. Include Images by Full URL</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/image-url.adoc[]</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="putting-images-in-their-place"><a class="anchor" href="#putting-images-in-their-place"></a><a class="link" href="#putting-images-in-their-place">31.2. Putting Images in Their Place</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/image-position.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="sizing-images"><a class="anchor" href="#sizing-images"></a><a class="link" href="#sizing-images">31.3. Sizing Images</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/image-sizing.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="summary-5"><a class="anchor" href="#summary-5"></a><a class="link" href="#summary-5">31.4. Summary</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-image.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="video"><a class="anchor" href="#video"></a><a class="link" href="#video">32. Video</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/video.adoc[]</p>
</div>
<div class="sect2">
<h3 id="supported-attributes"><a class="anchor" href="#supported-attributes"></a><a class="link" href="#supported-attributes">32.1. Supported Attributes</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-video.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="audio"><a class="anchor" href="#audio"></a><a class="link" href="#audio">33. Audio</a></h2>
<div class="sectionbody">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Pending
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="summary-6"><a class="anchor" href="#summary-6"></a><a class="link" href="#summary-6">33.1. Summary</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-audio.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="admonition"><a class="anchor" href="#admonition"></a><a class="link" href="#admonition">34. Admonition</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/admonition.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="sidebar"><a class="anchor" href="#sidebar"></a><a class="link" href="#sidebar">35. Sidebar</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sidebar.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="example"><a class="anchor" href="#example"></a><a class="link" href="#example">36. Example</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/example.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="prose-excerpts-quotes-and-verses"><a class="anchor" href="#prose-excerpts-quotes-and-verses"></a><a class="link" href="#prose-excerpts-quotes-and-verses">37. Prose Excerpts, Quotes and Verses</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/quote.adoc[tag=intro]</p>
</div>
<div class="sect2">
<h3 id="quote"><a class="anchor" href="#quote"></a><a class="link" href="#quote">37.1. Quote</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/quote.adoc[tag=basic]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/quote-alt.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="verse"><a class="anchor" href="#verse"></a><a class="link" href="#verse">37.2. Verse</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/verse.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="comments"><a class="anchor" href="#comments"></a><a class="link" href="#comments">38. Comments</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/comment.adoc[]</p>
</div>
</div>
</div>
<h1 id="controlling-your-content" class="sect0"><a class="anchor" href="#controlling-your-content"></a><a class="link" href="#controlling-your-content">Controlling Your Content</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Part introduction pending
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="subs"><a class="anchor" href="#subs"></a><a class="link" href="#subs">39. Text Substitutions</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs.adoc[]</p>
</div>
<div class="sect2">
<h3 id="special-characters"><a class="anchor" href="#special-characters"></a><a class="link" href="#special-characters">39.1. Special Characters</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-specchar.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="quotes"><a class="anchor" href="#quotes"></a><a class="link" href="#quotes">39.2. Quotes</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-quote.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="attributes-2"><a class="anchor" href="#attributes-2"></a><a class="link" href="#attributes-2">39.3. Attributes</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-attr.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="replacements"><a class="anchor" href="#replacements"></a><a class="link" href="#replacements">39.4. Replacements</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-repl.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="subs-mac"><a class="anchor" href="#subs-mac"></a><a class="link" href="#subs-mac">39.5. Macros</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-macro.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="post-replacements"><a class="anchor" href="#post-replacements"></a><a class="link" href="#post-replacements">39.6. Post Replacements</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-post.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="applying-substitutions"><a class="anchor" href="#applying-substitutions"></a><a class="link" href="#applying-substitutions">39.7. Applying Substitutions</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-apply.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="preventing-substitutions"><a class="anchor" href="#preventing-substitutions"></a><a class="link" href="#preventing-substitutions">39.8. Preventing Substitutions</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/subs-prevent.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="literal-text-and-blocks"><a class="anchor" href="#literal-text-and-blocks"></a><a class="link" href="#literal-text-and-blocks">40. Literal Text and Blocks</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/literal.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="listing-blocks"><a class="anchor" href="#listing-blocks"></a><a class="link" href="#listing-blocks">41. Listing Blocks</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/listing.adoc[]</p>
</div>
<div class="sect2">
<h3 id="to-wrap-or-to-scroll"><a class="anchor" href="#to-wrap-or-to-scroll"></a><a class="link" href="#to-wrap-or-to-scroll">41.1. To Wrap or to Scroll</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/listing-wrap.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="summary-7"><a class="anchor" href="#summary-7"></a><a class="link" href="#summary-7">41.2. Summary</a></h3>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Pending
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="passthroughs"><a class="anchor" href="#passthroughs"></a><a class="link" href="#passthroughs">42. Passthroughs</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/pass-intro.adoc[]</p>
</div>
<div class="sect2">
<h3 id="pass-macros"><a class="anchor" href="#pass-macros"></a><a class="link" href="#pass-macros">42.1. Passthrough Macros</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/pass-macro.adoc[]</p>
</div>
<div class="sect3">
<h4 id="nesting-blocks-and-passthrough-macros"><a class="anchor" href="#nesting-blocks-and-passthrough-macros"></a><a class="link" href="#nesting-blocks-and-passthrough-macros">42.1.1. Nesting blocks and passthrough macros</a></h4>
<div class="paragraph">
<p>When you&#8217;re using passthroughs inside literal and listing blocks, it can be easy to forget that the triple-plus, double-dollar, and backtick passthroughs are macros (not quotes).
If you want to enable the passthroughs, make sure to assign the <code>macros</code> value to the <code>subs</code> attribute.</p>
</div>
<div class="literalblock">
<div class="content">
<pre>[source,java,subs="+quotes,+macros"]
----
protected void configure(HttpSecurity http) throws Exception {
    http
        .authorizeRequests()
            **.antMatchers("/resources/$$**$$").permitAll()**
            .anyRequest().authenticated()
            .and()
        .formLogin()
            .loginPage("/login")
            .permitAll();
----</pre>
</div>
</div>
<div class="exampleblock">
<div class="content">
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">protected</span> <span class="type">void</span> configure(HttpSecurity http) <span class="directive">throws</span> <span class="exception">Exception</span> {
    http
        .authorizeRequests()
            <strong>.antMatchers(<span class="string"><span class="delimiter">&quot;</span><span class="content">/resources/**</span><span class="delimiter">&quot;</span></span>).permitAll()</strong>
            .anyRequest().authenticated()
            .and()
        .formLogin()
            .loginPage(<span class="string"><span class="delimiter">&quot;</span><span class="content">/login</span><span class="delimiter">&quot;</span></span>)
            .permitAll();</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="pass-blocks"><a class="anchor" href="#pass-blocks"></a><a class="link" href="#pass-blocks">42.2. Passthrough Blocks</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/pass-block.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="open-blocks"><a class="anchor" href="#open-blocks"></a><a class="link" href="#open-blocks">43. Open Blocks</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/open.adoc[]</p>
</div>
</div>
</div>
<h1 id="enriching-your-content" class="sect0"><a class="anchor" href="#enriching-your-content"></a><a class="link" href="#enriching-your-content">Enriching Your Content</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Part introduction pending
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="stem"><a class="anchor" href="#stem"></a><a class="link" href="#stem">44. Equations and Formulas</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/stem.adoc[tag=intro]</p>
</div>
<div class="sect2">
<h3 id="stem-in"><a class="anchor" href="#stem-in"></a><a class="link" href="#stem-in">44.1. Inline Stem Content</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/stem.adoc[tag=in]</p>
</div>
</div>
<div class="sect2">
<h3 id="stem-bl"><a class="anchor" href="#stem-bl"></a><a class="link" href="#stem-bl">44.2. Block Stem Content</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/stem.adoc[tag=bl]</p>
</div>
</div>
<div class="sect2">
<h3 id="using-multiple-stem-interpreters"><a class="anchor" href="#using-multiple-stem-interpreters"></a><a class="link" href="#using-multiple-stem-interpreters">44.3. Using Multiple Stem Interpreters</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/stem.adoc[tag=inter]</p>
</div>
</div>
<div class="sect2">
<h3 id="stem-docbook"><a class="anchor" href="#stem-docbook"></a><a class="link" href="#stem-docbook">44.4. Enabling STEM expressions in the DocBook Toolchain</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/stem.adoc[tag=docbook]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-interface-macros"><a class="anchor" href="#user-interface-macros"></a><a class="link" href="#user-interface-macros">45. User Interface Macros</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/ui.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="icons"><a class="anchor" href="#icons"></a><a class="link" href="#icons">46. Icons</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/icons.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="source-code-blocks"><a class="anchor" href="#source-code-blocks"></a><a class="link" href="#source-code-blocks">47. Syntax Highlighting Source Code</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/src.adoc[]</p>
</div>
<div class="sect2">
<h3 id="pygments"><a class="anchor" href="#pygments"></a><a class="link" href="#pygments">47.1. Pygments</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/src-pygments.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="coderay"><a class="anchor" href="#coderay"></a><a class="link" href="#coderay">47.2. CodeRay</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/src-coderay.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="highlight-js"><a class="anchor" href="#highlight-js"></a><a class="link" href="#highlight-js">47.3. highlight.js</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/src-highlightjs.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="callouts"><a class="anchor" href="#callouts"></a><a class="link" href="#callouts">48. Callouts</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/callout-intro.adoc[]</p>
</div>
<div class="sect2">
<h3 id="copy-and-paste-friendly-callouts"><a class="anchor" href="#copy-and-paste-friendly-callouts"></a><a class="link" href="#copy-and-paste-friendly-callouts">48.1. Copy and Paste Friendly Callouts</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/callout-copy.adoc[]</p>
</div>
<div class="sect3">
<h4 id="xml-callouts"><a class="anchor" href="#xml-callouts"></a><a class="link" href="#xml-callouts">48.1.1. XML Callouts</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/callout-xml.adoc[]</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="callout-icons"><a class="anchor" href="#callout-icons"></a><a class="link" href="#callout-icons">48.2. Callout Icons</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/callout-icon.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="conditional-preprocessor-directives"><a class="anchor" href="#conditional-preprocessor-directives"></a><a class="link" href="#conditional-preprocessor-directives">49. Conditional Preprocessor Directives</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/conditional-preprocessor-directives.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="docinfo-file"><a class="anchor" href="#docinfo-file"></a><a class="link" href="#docinfo-file">50. Docinfo Files</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/docinfo.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="counters"><a class="anchor" href="#counters"></a><a class="link" href="#counters">51. Counters</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/counter.adoc[]</p>
</div>
</div>
</div>
<h1 id="structuring-navigating-and-referencing-your-content" class="sect0"><a class="anchor" href="#structuring-navigating-and-referencing-your-content"></a><a class="link" href="#structuring-navigating-and-referencing-your-content">Structuring, Navigating, and Referencing Your Content</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/structure-intro.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="title-page"><a class="anchor" href="#title-page"></a><a class="link" href="#title-page">52. Title Page</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/448">Issue 448</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-colophon"><a class="anchor" href="#user-colophon"></a><a class="link" href="#user-colophon">53. Colophon</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/colophon.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-toc"><a class="anchor" href="#user-toc"></a><a class="link" href="#user-toc">54. Table of Contents</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/toc-intro.adoc[]</p>
</div>
<div class="sect2">
<h3 id="manual-placement"><a class="anchor" href="#manual-placement"></a><a class="link" href="#manual-placement">54.1. In-Document Placement</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/toc-layout.adoc[tag=place]</p>
</div>
</div>
<div class="sect2">
<h3 id="left-or-right-column-layout"><a class="anchor" href="#left-or-right-column-layout"></a><a class="link" href="#left-or-right-column-layout">54.2. Side Column Placement</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/toc-layout.adoc[tag=column]</p>
</div>
</div>
<div class="sect2">
<h3 id="user-toc-title"><a class="anchor" href="#user-toc-title"></a><a class="link" href="#user-toc-title">54.3. Title</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/toc-custom.adoc[tag=title]</p>
</div>
</div>
<div class="sect2">
<h3 id="user-toc-levels"><a class="anchor" href="#user-toc-levels"></a><a class="link" href="#user-toc-levels">54.4. Levels</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/toc-custom.adoc[tag=level]</p>
</div>
</div>
<div class="sect2">
<h3 id="using-a-toc-with-embeddable-html"><a class="anchor" href="#using-a-toc-with-embeddable-html"></a><a class="link" href="#using-a-toc-with-embeddable-html">54.5. Using a TOC with Embeddable HTML</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/toc-embeddable-html.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="table-of-contents-summary"><a class="anchor" href="#table-of-contents-summary"></a><a class="link" href="#table-of-contents-summary">54.6. Table of Contents Summary</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/sum-toc.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-abstract"><a class="anchor" href="#user-abstract"></a><a class="link" href="#user-abstract">55. Abstract</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/abstract.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-preface"><a class="anchor" href="#user-preface"></a><a class="link" href="#user-preface">56. Preface</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/preface.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-dedication"><a class="anchor" href="#user-dedication"></a><a class="link" href="#user-dedication">57. Dedication</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/dedication.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="book-parts-and-chapters"><a class="anchor" href="#book-parts-and-chapters"></a><a class="link" href="#book-parts-and-chapters">58. Book Parts and Chapters</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/book-part.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-appendix"><a class="anchor" href="#user-appendix"></a><a class="link" href="#user-appendix">59. Appendix</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/appendix.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-glossary"><a class="anchor" href="#user-glossary"></a><a class="link" href="#user-glossary">60. Glossary</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/glossary.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-biblio"><a class="anchor" href="#user-biblio"></a><a class="link" href="#user-biblio">61. Bibliography</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/biblio.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-index"><a class="anchor" href="#user-index"></a><a class="link" href="#user-index">62. Index</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/index.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="user-footnotes"><a class="anchor" href="#user-footnotes"></a><a class="link" href="#user-footnotes">63. Footnotes</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/footnote.adoc[]</p>
</div>
</div>
</div>
<h1 id="processing-your-content" class="sect0"><a class="anchor" href="#processing-your-content"></a><a class="link" href="#processing-your-content">Processing Your Content</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/process-intro.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="selecting-an-output-format"><a class="anchor" href="#selecting-an-output-format"></a><a class="link" href="#selecting-an-output-format">64. Selecting an Output Format</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/output-format.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="html"><a class="anchor" href="#html"></a><a class="link" href="#html">65. HTML</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Asciidoctor&#8217;s default output format is HTML.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>html5</code></dt>
<dd>
<p>HTML 5 markup styled with CSS3.</p>
</dd>
</dl>
</div>
<div class="sect2">
<h3 id="using-the-command-line"><a class="anchor" href="#using-the-command-line"></a><a class="link" href="#using-the-command-line">65.1. Using the Command Line</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/html-command-line.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="using-the-ruby-api-2"><a class="anchor" href="#using-the-ruby-api-2"></a><a class="link" href="#using-the-ruby-api-2">65.2. Using the Ruby API</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/html-ruby-api.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="styling-the-html-with-css"><a class="anchor" href="#styling-the-html-with-css"></a><a class="link" href="#styling-the-html-with-css">65.3. Styling the HTML with CSS</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/html-styles.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="managing-images"><a class="anchor" href="#managing-images"></a><a class="link" href="#managing-images">65.4. Managing Images</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/html-manage-images.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="hl-css"><a class="anchor" href="#hl-css"></a><a class="link" href="#hl-css">65.5. CodeRay and Pygments Stylesheets</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/html-code-styles.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="xhtml"><a class="anchor" href="#xhtml"></a><a class="link" href="#xhtml">66. XHTML</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/xhtml.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="docbook"><a class="anchor" href="#docbook"></a><a class="link" href="#docbook">67. DocBook</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/docbook.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="man-pages"><a class="anchor" href="#man-pages"></a><a class="link" href="#man-pages">68. Man Pages</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/manpage.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="pdfs"><a class="anchor" href="#pdfs"></a><a class="link" href="#pdfs">69. PDFs</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Conversion from AsciiDoc to PDF is made possible by a number of tools.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><a href="https://github.com/asciidoctor/asciidoctor-pdf">Asciidoctor PDF</a></dt>
<dd>
<p>A native PDF converter for Asciidoctor (converts directly from AsciiDoc to PDF using Prawn).</p>
<div class="paragraph">
<p>Instructions for installing and using Asciidoctor PDF are documented in the project&#8217;s <a href="https://github.com/asciidoctor/asciidoctor-pdf/blob/master/README.adoc">README</a>.
The tool provides built-in theming via a YAML configuration file, which is documented in the <a href="http://gist.asciidoctor.org/?github-asciidoctor%2Fasciidoctor-pdf%2F%2Fdocs%2Ftheming-guide.adoc">theming guide</a>.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Asciidoctor PDF is the preferred tool for converting to PDF and is fully supported by the Asciidoctor community.
</td>
</tr>
</table>
</div>
</dd>
<dt class="hdlist1">a2x</dt>
<dd>
<p>A DocBook toolchain frontend provided by that AsciiDoc Python project.</p>
<div class="paragraph">
<p>To use this tool, you should first convert to DocBook using Asciidoctor, then convert the DocBook to PDF using a2x.
a2x accepts a DocBook file as input and can convert it to a PDF using either Apache FOP or dblatex.
Instructions for using a2x are documented in the project&#8217;s <a href="http://asciidoc.org/a2x.1.html">man page</a>.</p>
</div>
</dd>
<dt class="hdlist1"><a href="https://github.com/asciidoctor/asciidoctor-fopub">asciidoctor-fopub</a></dt>
<dd>
<p>A DocBook toolchain frontend similar to a2x, but which only requires Java to be installed on your machine.</p>
<div class="paragraph">
<p>Instructions for using asciidoctor-fopub are documented in the project&#8217;s <a href="https://github.com/asciidoctor/asciidoctor-fopub/blob/master/README.adoc">README</a>.
To alter the look and feel of the PDF, it&#8217;s necessary to pass XSL parameters or modify the XSLT.
More information about customization can be found in <a href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</a>.</p>
</div>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="preview-your-content"><a class="anchor" href="#preview-your-content"></a><a class="link" href="#preview-your-content">70. Preview Your Content</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/449">Issue 449</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="guard-live-viewer"><a class="anchor" href="#guard-live-viewer"></a><a class="link" href="#guard-live-viewer">70.1. Guard/Live Viewer</a></h3>
<div class="paragraph">
<p>Guard::AsciiDoc is a plugin for <a href="https://github.com/guard/guard">Guard</a> that renders watched AsciiDoc files to the specified output format whenever they change using Asciidoctor.</p>
</div>
<div class="paragraph">
<p>Instructions for using the Guard/Live viewer are documented in the project&#8217;s <a href="https://github.com/asciidoctor/guard-asciidoc/blob/master/README.adoc">README</a>.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="process-multiple-source-files-from-the-cli"><a class="anchor" href="#process-multiple-source-files-from-the-cli"></a><a class="link" href="#process-multiple-source-files-from-the-cli">71. Process Multiple Source Files from the CLI</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/process-multi.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="specifying-an-output-file"><a class="anchor" href="#specifying-an-output-file"></a><a class="link" href="#specifying-an-output-file">72. Specifying an Output File</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/file-output.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="running-asciidoctor-securely"><a class="anchor" href="#running-asciidoctor-securely"></a><a class="link" href="#running-asciidoctor-securely">73. Running Asciidoctor Securely</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/secure.adoc[]</p>
</div>
<div class="sect2">
<h3 id="set-the-safe-mode-in-the-cli"><a class="anchor" href="#set-the-safe-mode-in-the-cli"></a><a class="link" href="#set-the-safe-mode-in-the-cli">73.1. Set the Safe Mode in the CLI</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/secure-cli.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="set-the-safe-mode-in-the-api"><a class="anchor" href="#set-the-safe-mode-in-the-api"></a><a class="link" href="#set-the-safe-mode-in-the-api">73.2. Set the Safe Mode in the API</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/secure-api.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="set-attributes-based-on-the-safe-mode"><a class="anchor" href="#set-attributes-based-on-the-safe-mode"></a><a class="link" href="#set-attributes-based-on-the-safe-mode">73.3. Set Attributes Based on the Safe Mode</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/secure-attr.adoc[]</p>
</div>
</div>
</div>
</div>
<h1 id="customizing-your-output" class="sect0"><a class="anchor" href="#customizing-your-output"></a><a class="link" href="#customizing-your-output">Customizing Your Output</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="paragraph">
<p>Asciidoctor provides a default stylesheet and built-in converters so you can quickly process and render your document, but it also lets you use custom stylesheets and converters.
The Asciidoctor project includes alternative stylesheet themes from <a href="#stylesheet-factory">the stylesheet factory</a> and <a href="#slideshows">specialized backends</a>, such as the <a href="#deckjs">Deck.js backend</a>.
You can also create your own <a href="#custom-themes">themes</a> and <a href="#custom-backends">backends</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="custom-themes"><a class="anchor" href="#custom-themes"></a><a class="link" href="#custom-themes">74. Custom Themes</a></h2>
<div class="sectionbody">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Section introduction pending
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="creating-a-theme"><a class="anchor" href="#creating-a-theme"></a><a class="link" href="#creating-a-theme">74.1. Creating a Theme</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/create-theme.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="applying-a-theme"><a class="anchor" href="#applying-a-theme"></a><a class="link" href="#applying-a-theme">74.2. Applying a Theme</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/apply-theme.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="stylesheet-factory"><a class="anchor" href="#stylesheet-factory"></a><a class="link" href="#stylesheet-factory">75. Stylesheet Factory</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/factory-intro.adoc[]</p>
</div>
<div class="sect2">
<h3 id="setting-up-the-factory"><a class="anchor" href="#setting-up-the-factory"></a><a class="link" href="#setting-up-the-factory">75.1. Setting up the Factory</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/factory-setup.adoc[tag=setup]</p>
</div>
<div class="sect3">
<h4 id="install-the-gems"><a class="anchor" href="#install-the-gems"></a><a class="link" href="#install-the-gems">75.1.1. Install the Gems</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/factory-setup.adoc[tag=gem]</p>
</div>
</div>
<div class="sect3">
<h4 id="build-the-stylesheets"><a class="anchor" href="#build-the-stylesheets"></a><a class="link" href="#build-the-stylesheets">75.1.2. Build the Stylesheets</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/factory-setup.adoc[tag=build]</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="applying-a-stylesheet"><a class="anchor" href="#applying-a-stylesheet"></a><a class="link" href="#applying-a-stylesheet">75.2. Applying a Stylesheet</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/factory-apply.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="generate-an-html-document"><a class="anchor" href="#generate-an-html-document"></a><a class="link" href="#generate-an-html-document">75.3. Generate an HTML Document</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/factory-gen.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="external-preview"><a class="anchor" href="#external-preview"></a><a class="link" href="#external-preview">75.4. External Preview</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/factory-preview.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="slideshows"><a class="anchor" href="#slideshows"></a><a class="link" href="#slideshows">76. Slideshows</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>The conversion to HTML-based slides is handled by a custom backend.
The backends usually requires that you adhere to a set of conventions to define a slide and its content.
But there&#8217;s nothing in that content that restricts the document from being converted to a regular HTML page or PDF.</p>
</div>
<div class="paragraph">
<p>The first backend created was the one for deck.js.
Asciidoctor has backends for generating dzslides and reveal.js presentations as well.
Backends for other presentation frameworks are in the works.</p>
</div>
<div class="sect2">
<h3 id="deckjs"><a class="anchor" href="#deckjs"></a><a class="link" href="#deckjs">76.1. Deck.js</a></h3>
<div class="paragraph">
<p>The <a href="http://github.com/asciidoctor/asciidoctor-backends">deck.js backend</a> for Asciidoctor is a collection of Haml templates that transform an AsciiDoc document to HTML 5-based slides animated by <a href="http://imakewebthings.com/deck.js">deck.js</a>.</p>
</div>
<div class="sect3">
<h4 id="gem-requirements"><a class="anchor" href="#gem-requirements"></a><a class="link" href="#gem-requirements">76.1.1. Gem Requirements</a></h4>
<div class="paragraph">
<p>The Asciidoctor deck.js backend requires the following gems:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>asciidoctor</p>
</li>
<li>
<p>tilt</p>
</li>
<li>
<p>haml</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>To determine what gems are installed on your system, open a terminal window and type:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>$ gem list --local</pre>
</div>
</div>
<div class="paragraph">
<p>A list of installed gems will be returned.</p>
</div>
<div class="paragraph">
<p>If you&#8217;re missing the <code>asciidoctor</code>, <code>tilt</code>, or <code>haml</code> gems, install them from the command line with <code>gem install</code>.</p>
</div>
<div class="literalblock">
<div class="content">
<pre>$ gem install asciidoctor tilt haml</pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="backend-and-deck-js-installation"><a class="anchor" href="#backend-and-deck-js-installation"></a><a class="link" href="#backend-and-deck-js-installation">76.1.2. Backend and deck.js Installation</a></h4>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Download or <code>git clone</code> the <a href="http://github.com/asciidoctor/asciidoctor-backends">Asciidoctor backends</a> repository.</p>
<div class="literalblock">
<div class="content">
<pre>$ git clone git://github.com/asciidoctor/asciidoctor-backends.git</pre>
</div>
</div>
</li>
<li>
<p>Create a directory named <code>deck.js</code> inside your working directory (i.e. where your AsciiDoc document resides).</p>
</li>
<li>
<p><a href="https://github.com/imakewebthings/deck.js/archive/latest.zip">Download</a> and extract the deck.js archive or <code>git clone</code> the <a href="https://github.com/imakewebthings/deck.js">deck.js</a> repository into the <code>deck.js</code> directory you created in step 2.</p>
<div class="literalblock">
<div class="content">
<pre>$ git clone git://github.com/imakewebthings/deck.js.git</pre>
</div>
</div>
</li>
<li>
<p>If you plan to split your slides, <a href="https://github.com/houqp/deck.split.js">download the <code>deck.split.js</code> extension</a> and copy it into the <code>deck.js/extensions</code> directory.</p>
</li>
<li>
<p>If you want to use the fullscreen photo feature, create an <code>images</code> directory in your working directory.</p>
</li>
</ol>
</div>
</div>
<div class="sect3">
<h4 id="deckjs-backend-attributes"><a class="anchor" href="#deckjs-backend-attributes"></a><a class="link" href="#deckjs-backend-attributes">76.1.3. Deckjs Backend Attributes</a></h4>
<div class="paragraph">
<p>There are a number of document attributes specific to the <code>deckjs</code> backend.</p>
</div>
<table class="tableblock frame-all grid-all spread">
<caption class="title"><code>deckjs</code> backend document attributes</caption>
<colgroup>
<col style="width: 40%;">
<col style="width: 20%;">
<col style="width: 40%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Attribute</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:backend: deckjs</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Activates the deck.js backend to render the document as a deck.js presentation</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:backend: deckjs</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:deckjs_theme: &lt;theme&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the deck.js theme to neon, swiss or web-2.0</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:deckjs_theme: web-2.0</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:deckjs_transition: &lt;type&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets the transition style to horizontal-slide, vertical-slide or fade</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:deckjs_transition: fade</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:customjs: &lt;javascript location&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets a custom javascript file; can be used as a deck.js custom configuration</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:customjs: &lt;javascript location&gt;</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:customcss: &lt;css location&gt;</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Sets a custom css file</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:customcss: &lt;css location&gt;</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:menu:</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Toggle to and from a grid layout overview of all the slides by pressing the <code>m</code> key</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:menu:</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:navigation:</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Renders clickable previous and next navigation icons on the slides</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:navigation:</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:status:</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Renders the current slide number and total number of slides</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:status:</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">:split:</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Registers the split module for use in the document</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>:split:</code></p></td>
</tr>
</tbody>
</table>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
You can also specify a custom stylesheet using the <code>stylesheet</code> attribute, which customizes AsciiDoc elements like section, paragraph, images, etc.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The attributes described in the table above are set in the header of your document.</p>
</div>
<div class="literalblock">
<div class="title">Header with <code>deckjs</code> backend attributes</div>
<div class="content">
<pre>= Presentation Title
Presenter Name
:backend: deckjs
:deckjs_theme: web-2.0
:deckjs_transition: horizontal-slide
:navigation:</pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="slide-syntax-examples"><a class="anchor" href="#slide-syntax-examples"></a><a class="link" href="#slide-syntax-examples">76.1.4. Slide syntax Examples</a></h4>
<div class="paragraph">
<p>Structuring a slideshow and writing the slide content uses the same syntax as a typical AsciiDoc document, with a few added features.</p>
</div>
<div class="paragraph">
<p>Let&#8217;s see some examples of the <code>deckjs</code> backend features:</p>
</div>
<div class="listingblock">
<div class="title">Slide titles and background images</div>
<div class="content">
<pre>= Title of Presentation <i class="conum" data-value="1"></i><b>(1)</b>
Presenter Name
:backend: deckjs
:deckjs_transition: fade
:navigation:

== Title of Slide One <i class="conum" data-value="2"></i><b>(2)</b>

This is the first slide after the title slide.

[canvas-image="images/example.jpg"] <i class="conum" data-value="3"></i><b>(3)</b>
== Slide Two's Title will not be displayed <i class="conum" data-value="4"></i><b>(4)</b>

[role="canvas-caption", position="center-up"] <i class="conum" data-value="5"></i><b>(5)</b>
This text is displayed on top of the example.jpg image.</pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>The presentation title and author&#8217;s name will be displayed on the title slide.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Each new slide is designated by a level 1 section title (<code>==</code>).</td>
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
<td>The <code>canvas-image</code> attribute embeds a fullscreen image as a slide background. Position the attribute above the title of the slide you want the image applied to.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>When the <code>canvas-image</code> attribute is applied to a slide, that slide&#8217;s title will not be displayed.</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td><code>canvas-caption</code> applies a colored box around the caption text. <code>position</code> specifies the location of the caption block (bottom-left, top-left, bottom-right, top-right, center-up, center-down)</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Stepped paragraphs, lists, and blocks</div>
<div class="content">
<pre>== Stepped paragraphs

[options="step"]
This paragraph is displayed first.

[options="step"]
Then this paragraph is displayed when the _Next_ arrow is clicked.

== Stepped list items

[options="step"]
* A bullet is displayed each time the _Next_ arrow is clicked.
* B
* C

== Stepped blocks

[options="step"]
----
Block one
----

[options="step"]
----
Block two
----</pre>
</div>
</div>
<div class="paragraph">
<p>The <code>step</code> option reveals each paragraph, bullet, etc. separately each time you click the <em>Next</em> arrow.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
The original AsciiDoc <code>deckjs</code> backend for the AsciiDoc processor used the option <code>incremental</code> instead of <code>step</code>.
We&#8217;ve changed it to <code>step</code> in order to save you some typing.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="title">Split</div>
<div class="content">
<pre>= Presentation Title
Presenter Name
:backend: deckjs
:split: <i class="conum" data-value="1"></i><b>(1)</b>

== This Slide is Split

This Slide will act like

&lt;&lt;&lt; <i class="conum" data-value="2"></i><b>(2)</b>

three individual slides with the same title

&lt;&lt;&lt;

once the document is rendered.</pre>
</div>
</div>
<div class="colist arabic">
<table>
<tr>
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>To create multiple, consecutive slides with the same title, set the <code>split</code> attribute in the document header.</td>
</tr>
<tr>
<td><i class="conum" data-value="2"></i><b>2</b></td>
<td>Then, within a slide, insert <code>&lt;&lt;&lt;</code> to specify the slide breaks.</td>
</tr>
</table>
</div>
</div>
<div class="sect3">
<h4 id="rendering"><a class="anchor" href="#rendering"></a><a class="link" href="#rendering">76.1.5. Rendering</a></h4>
<div class="paragraph">
<p>To render your presentation as HTML5, execute the command:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>$ asciidoctor -T ../asciidoctor-backends/haml presentation.adoc</pre>
</div>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>The command <code>-T</code> (<code>--template-dir</code>) tells the Asciidoctor processor to override the built-in backends.</p>
</li>
<li>
<p>Directly after <code>-T</code> is the path to where you saved or cloned the Asciidoctor backends repository containing the <code>deckjs</code> backend (step 1 under the <a href="#backend-and-deck-js-installation">installation section</a>).</p>
</li>
</ol>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="custom-backends"><a class="anchor" href="#custom-backends"></a><a class="link" href="#custom-backends">77. Custom Backends</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/451">Issue 451</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="creating-a-backend"><a class="anchor" href="#creating-a-backend"></a><a class="link" href="#creating-a-backend">77.1. Creating a Backend</a></h3>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/452">Issue 452</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="sect3">
<h4 id="storing-multiple-templates"><a class="anchor" href="#storing-multiple-templates"></a><a class="link" href="#storing-multiple-templates">77.1.1. Storing Multiple Templates</a></h4>
<div class="paragraph">
<p>Custom templates can be stored in multiple directories.
That means you can build on an existing backend by copying only the templates you want to modify.
Then, just pass both the directory holding the original templates and the directory containing your customized templates when you invoke Asciidoctor.</p>
</div>
<div class="paragraph">
<p>In the CLI, multiple template directories are specified by using the <code>-T</code> option multiple times.</p>
</div>
<div class="literalblock">
<div class="content">
<pre>$ asciidoctor -T /path/to/original/templates -T /path/to/modified/templates mysample.adoc</pre>
</div>
</div>
<div class="paragraph">
<p>In the API, multiple template directories are specified by passing an array to the <code>template_dirs</code> option:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="ruby"><span class="constant">Asciidoctor</span>.convert_file <span class="string"><span class="delimiter">'</span><span class="content">mysample.adoc</span><span class="delimiter">'</span></span>, <span class="key">safe</span>: <span class="symbol">:safe</span>
    <span class="key">template_dirs</span>: <span class="string"><span class="delimiter">%w(</span><span class="content">/path/to/original/templates /path/to/modified/templates</span><span class="delimiter">)</span></span></code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="language-support"><a class="anchor" href="#language-support"></a><a class="link" href="#language-support">78. Using Asciidoctor with Other Languages</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/language-support.adoc[]</p>
</div>
</div>
</div>
<h1 id="publishing-your-content" class="sect0"><a class="anchor" href="#publishing-your-content"></a><a class="link" href="#publishing-your-content">Publishing Your Content</a></h1>
<div class="openblock partintro">
<div class="content">
NOTE: Section pending
</div>
</div>
<div class="sect1">
<h2 id="repositories"><a class="anchor" href="#repositories"></a><a class="link" href="#repositories">79. Repositories</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/453">Issue 453</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="static-website-generators"><a class="anchor" href="#static-website-generators"></a><a class="link" href="#static-website-generators">80. Static Website Generators</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/454">Issue 454</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="front-matter-added-for-static-site-generators"><a class="anchor" href="#front-matter-added-for-static-site-generators"></a><a class="link" href="#front-matter-added-for-static-site-generators">80.1. Front Matter Added for Static Site Generators</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/static-front.adoc[]</p>
</div>
<div class="sect3">
<h4 id="configuring-attributes-for-awestruct"><a class="anchor" href="#configuring-attributes-for-awestruct"></a><a class="link" href="#configuring-attributes-for-awestruct">80.1.1. Configuring Attributes for Awestruct</a></h4>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/static-awe.adoc[]</p>
</div>
</div>
</div>
</div>
</div>
<h1 id="api" class="sect0"><a class="anchor" href="#api"></a><a class="link" href="#api">Using Asciidoctor&#8217;s API</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/api-intro.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="load-and-render-a-file-using-the-api"><a class="anchor" href="#load-and-render-a-file-using-the-api"></a><a class="link" href="#load-and-render-a-file-using-the-api">81. Load and Render a File Using the API</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/load-render-api.adoc[]</p>
</div>
<div class="sect2">
<h3 id="render-strings"><a class="anchor" href="#render-strings"></a><a class="link" href="#render-strings">81.1. Render Strings</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/string-api.adoc[]</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="provide-custom-templates"><a class="anchor" href="#provide-custom-templates"></a><a class="link" href="#provide-custom-templates">82. Provide Custom Templates</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/templates-api.adoc[]</p>
</div>
</div>
</div>
<h1 id="extensions" class="sect0"><a class="anchor" href="#extensions"></a><a class="link" href="#extensions">Extensions</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-intro.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="extension-points"><a class="anchor" href="#extension-points"></a><a class="link" href="#extension-points">83. Extension Points</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-point.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="example-extensions"><a class="anchor" href="#example-extensions"></a><a class="link" href="#example-extensions">84. Example Extensions</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Below are several examples of extensions and how they are registered.</p>
</div>
<div class="sect2">
<h3 id="preprocessor-example"><a class="anchor" href="#preprocessor-example"></a><a class="link" href="#preprocessor-example">84.1. Preprocessor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-pre.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="tree-processor-example"><a class="anchor" href="#tree-processor-example"></a><a class="link" href="#tree-processor-example">84.2. Tree Processor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-tree.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="postprocessor-example"><a class="anchor" href="#postprocessor-example"></a><a class="link" href="#postprocessor-example">84.3. Postprocessor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-post.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="docinfo-processor-example"><a class="anchor" href="#docinfo-processor-example"></a><a class="link" href="#docinfo-processor-example">84.4. Docinfo Processor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-docinfo.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="block-processor-example"><a class="anchor" href="#block-processor-example"></a><a class="link" href="#block-processor-example">84.5. Block Processor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-block.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="block-macro-processor-example"><a class="anchor" href="#block-macro-processor-example"></a><a class="link" href="#block-macro-processor-example">84.6. Block Macro Processor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-macro.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="inline-macro-processor-example"><a class="anchor" href="#inline-macro-processor-example"></a><a class="link" href="#inline-macro-processor-example">84.7. Inline Macro Processor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-in-macro.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="include-processor-example"><a class="anchor" href="#include-processor-example"></a><a class="link" href="#include-processor-example">84.8. Include Processor Example</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/exten-include.adoc[]</p>
</div>
<div class="paragraph">
<p>You can see plenty more extension examples in the <a href="https://github.com/asciidoctor/asciidoctor-extensions-lab">extensions lab</a>.</p>
</div>
</div>
</div>
</div>
<h1 id="build-integrations-and-implementations" class="sect0"><a class="anchor" href="#build-integrations-and-implementations"></a><a class="link" href="#build-integrations-and-implementations">Build Integrations and Implementations</a></h1>
<div class="sect1">
<h2 id="java"><a class="anchor" href="#java"></a><a class="link" href="#java">85. Java</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/455">Issue 455</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><a href="https://github.com/asciidoctor/asciidoctorj">AsciidoctorJ</a> is the official library for running Asciidoctor on the JVM.
Using AsciidoctorJ, you can convert AsciiDoc content or analyze the structure of a parsed AsciiDoc document from Java and other JVM languages.
For details see <a href="http://asciidoctor.org/docs/asciidoctorj">Getting Started with Asciidoctor in Java using AsciidoctorJ</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="gradle"><a class="anchor" href="#gradle"></a><a class="link" href="#gradle">86. Gradle</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/456">Issue 456</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The <a href="https://github.com/asciidoctor/asciidoctor-gradle-plugin">Asciidoctor Gradle Plugin</a> is the official means of using Asciidoctor to convert all your AsciiDoc documentation using Gradle.
For details see <a href="http://asciidoctor.org/docs/asciidoctor-gradle-plugin/">Getting Started with the Asciidoctor Gradle Plugin</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="maven"><a class="anchor" href="#maven"></a><a class="link" href="#maven">87. Maven</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/457">Issue 457</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The <a href="https://github.com/asciidoctor/asciidoctor-maven-plugin">Asciidoctor Maven Plugin</a> is the official way to convert your AsciiDoc documentation using Asciidoctor from an Apache Maven build.
For details see <a href="http://asciidoctor.org/docs/asciidoctor-maven-plugin">Installing and Using the Asciidoctor Maven Plugin</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="apache-ant"><a class="anchor" href="#apache-ant"></a><a class="link" href="#apache-ant">88. Apache Ant</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/asciidoctor-ant.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="javadoc"><a class="anchor" href="#javadoc"></a><a class="link" href="#javadoc">89. JavaDoc</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/458">Issue 458</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Using the <a href="https://github.com/asciidoctor/asciidoclet">Asciidoctor doclet</a>, you can write your Javadoc comments using all the features of Asciidoctor including tables, lists, code examples with syntax highlighting, and pictures.</p>
</div>
<div class="paragraph">
<p>If you want to incorporate your Javadoc into another document instead, there is an experimental doclet that exports them to AsciiDoc files.
See the <a href="https://github.com/johncarl81/exportdoclet">exportdoclet project</a> and the <a href="http://discuss.asciidoctor.org/Export-Javadoc-strings-td4172.html">related discussion thread</a> for details.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="javascript"><a class="anchor" href="#javascript"></a><a class="link" href="#javascript">90. JavaScript</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/459">Issue 459</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><a href="https://github.com/asciidoctor/asciidoctor.js">Asciidoctor.js</a> is a JavaScript port of Asciidoctor, transpiled directly from the Ruby version.
Asciidoctor.js brings the AsciiDoc syntax to the browser and the Node.js ecosystem.
For details see <a href="http://asciidoctor.org/docs/install-and-use-asciidoctorjs">Installing and Using Asciidoctor.js</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="yard"><a class="anchor" href="#yard"></a><a class="link" href="#yard">91. Yard</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/460">Issue 460</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="rdoc"><a class="anchor" href="#rdoc"></a><a class="link" href="#rdoc">92. Rdoc</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/461">Issue 461</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
</div>
</div>
<h1 id="conversions-and-migrations" class="sect0"><a class="anchor" href="#conversions-and-migrations"></a><a class="link" href="#conversions-and-migrations">Conversions and Migrations</a></h1>
<div class="openblock partintro">
<div class="content">
<div class="paragraph">
<p>In this part, you&#8217;ll learn how to migrate documents written in other documentation languages to AsciiDoc.
We&#8217;ll start with the simplest migration, switching from AsciiDoc Python, the original implementation of AsciiDoc, to Asciidoctor, the modern implementation.
We&#8217;ll then cover how to move to AsciiDoc from other documentation languages like DocBook, Markdown and HTML.
In addition to differences in the syntax, many of the sections also suggest tools you can use to ease the migration.</p>
</div>
</div>
</div>
<div id="migrating-from-asciidoc-python" class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/migrating-from-asciidoc-python.adoc[]</p>
</div>
<div class="sect1">
<h2 id="convert-docbook-xml-to-asciidoc"><a class="anchor" href="#convert-docbook-xml-to-asciidoc"></a><a class="link" href="#convert-docbook-xml-to-asciidoc">93. Convert DocBook XML to AsciiDoc</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/docbookrx.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="convert-markdown-to-asciidoc"><a class="anchor" href="#convert-markdown-to-asciidoc"></a><a class="link" href="#convert-markdown-to-asciidoc">94. Convert Markdown to AsciiDoc</a></h2>
<div class="sectionbody">
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/462">Issue 462</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Asciidoctor recognizes a fair amount of Markdown syntax, thus allowing you to migrate from Markdown to AsciiDoc gradually.
See <a href="http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#markdown-compatibility">Markdown Compatibility</a> to learn what syntax is shared.
The syntax you must change is listed in <a href="#asciidoc-vs-markdown">[asciidoc-vs-markdown]</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="convert-confluence-xhtml-to-asciidoc"><a class="anchor" href="#convert-confluence-xhtml-to-asciidoc"></a><a class="link" href="#convert-confluence-xhtml-to-asciidoc">95. Convert Confluence XHTML to AsciiDoc</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/convert-from-confluence-xhtml.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="convert-ms-word-to-asciidoc"><a class="anchor" href="#convert-ms-word-to-asciidoc"></a><a class="link" href="#convert-ms-word-to-asciidoc">96. Convert MS Word to AsciiDoc</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>See <a href="http://asciidoctor.org/docs/migrating-from-msword">Migrating to AsciiDoc from MS Word</a>.</p>
</div>
</div>
</div>
<h1 id="resources" class="sect0"><a class="anchor" href="#resources"></a><a class="link" href="#resources">Resources</a></h1>
<div class="openblock partintro">
<div class="content">
NOTE: Section pending
</div>
</div>
<div class="sect1">
<h2 id="copyright-and-license"><a class="anchor" href="#copyright-and-license"></a><a class="link" href="#copyright-and-license">97. Copyright and License</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/project-lic.adoc[]</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="authors"><a class="anchor" href="#authors"></a><a class="link" href="#authors">98. Authors</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/project-author.adoc[]</p>
</div>
<div id="troubleshoot" class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/troubleshoot.adoc[]
:leveloffset: 0</p>
</div>
<div class="sect2">
<h3 id="glossary"><a class="anchor" href="#glossary"></a><a class="link" href="#glossary">98.1. Glossary</a></h3>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="title">Discuss and Contribute</div>
Use <a href="https://github.com/asciidoctor/asciidoctor.org/issues/465">Issue 465</a> to drive development of this section. Your contributions make a difference. No contribution is too small.
</td>
</tr>
</table>
</div>
<div class="dlist glossary">
<dl>
<dt>admonition</dt>
<dd>
<p>a callout paragraph or block that has a label or icon indicating its priority.</p>
</dd>
<dt>backend</dt>
<dd>
<p>a moniker for the expected output format; used as a key to select which converter to use; often used interchangeably with the name of a converter (i.e., the "html5" backend").</p>
</dd>
<dt>block attribute</dt>
<dd>
<p>an attribute associated with a delimited block or paragraph; these attributes can affect processing of the block, and are available to block processors, but cannot be referenced using an attribute reference.</p>
</dd>
<dt>built-in attribute</dt>
<dd>
<p>a document attribute that controls processing, integrations, styling, and localization.</p>
</dd>
<dt>cross reference</dt>
<dd>
<p>a link from one location in the document to another location marked by an anchor.</p>
</dd>
<dt>document attribute</dt>
<dd>
<p>an attribute associated with the document (node); in other words, an attribute in the global document attributes dictionary; the value of these attributes can be referenced using an attribute reference; if defined in the header, the document attribute is known as a header attribute.</p>
</dd>
<dt>environment attribute</dt>
<dd>
<p>a dynamic document attribute that pertains to, or gives information about, the runtime environment.</p>
</dd>
<dt>header attribute</dt>
<dd>
<p>a document attribute defined in the document header; visible from all nodes in the document; often required for global settings such as the source highlighter or icons mode.</p>
</dd>
<dt>list continuation</dt>
<dd>
<p>a plus sign (<code>+</code>) on a line by itself that connects adjacent lines of text to a list item.</p>
</dd>
<dt>macro attribute</dt>
<dd>
<p>an attribute associated with a block or inline macro; these attributes can affect processing of the macro, and are available to macro processors, but cannot be referenced using an attribute reference.</p>
</dd>
<dt>predefined attribute</dt>
<dd>
<p>a document attribute defined for convenience; often used for inserting special content characters.</p>
</dd>
<dt>quoted text</dt>
<dd>
<p>text which is enclosed in special punctuation to give it emphasis or special meaning.</p>
</dd>
<dt>user-defined attribute</dt>
<dd>
<p>a document attribute defined by the content author; used for storing reusable content, and controlling conditional inclusion.</p>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="attribute-catalog"><a class="anchor" href="#attribute-catalog"></a><a class="link" href="#attribute-catalog">Appendix A: Catalog of Document Attributes</a></h3>
<div class="paragraph">
<p>This appendix catalogs all the recognized document attributes in Asciidoctor.
It includes environment, built-in and predefined (aka character reference) attributes.
Authors may define any number of additional attributes (aka user-defined attributes) for their own purposes.</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attrs-env.adoc[leveloffset=2]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attrs-builtin.adoc[leveloffset=2]</p>
</div>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/attrs-charref.adoc[leveloffset=2]</p>
</div>
</div>
<div class="sect2">
<h3 id="cli-options"><a class="anchor" href="#cli-options"></a><a class="link" href="#cli-options">Appendix B: CLI Options</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/cli-options.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="ruby-api-options"><a class="anchor" href="#ruby-api-options"></a><a class="link" href="#ruby-api-options">Appendix C: Ruby API Options</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/ruby-api-options.adoc[]</p>
</div>
</div>
<div class="sect2">
<h3 id="app-messages"><a class="anchor" href="#app-messages"></a><a class="link" href="#app-messages">Appendix D: Application Messages</a></h3>
<div class="paragraph">
<p>Unresolved directive in user-manual.adoc - include::_includes/messages.adoc[]</p>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2017-10-26 13:19:22 CST
</div>
</div>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  messageStyle: "none",
  tex2jax: {
    inlineMath: [["\\(", "\\)"]],
    displayMath: [["\\[", "\\]"]],
    ignoreClass: "nostem|nolatexmath"
  },
  asciimath2jax: {
    delimiters: [["\\$", "\\$"]],
    ignoreClass: "nostem|noasciimath"
  },
  TeX: { equationNumbers: { autoNumber: "none" } }
});
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.6.0/MathJax.js?config=TeX-MML-AM_HTMLorMML"></script>
</body>
</html>